feat(server): album's email notification (#9439)

* feat(server): album's email notification

* same size button

* skeleton for album invite and album update event

* album invite content

* album update

* fix(server): smtp certificate validation (#9506)

* album update content

* send mail

* album invite with thumbnail

* pr feedback

* styling

* Send email to update album event

* better naming

* add tests

* Update album-invite.email.tsx

Co-authored-by: bo0tzz <git@bo0tzz.me>

* Update album-update.email.tsx

Co-authored-by: bo0tzz <git@bo0tzz.me>

* fix: unit tests

* typo

* Update server/src/services/notification.service.ts

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>

* PR feedback

* Update server/src/emails/album-update.email.tsx

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

---------

Co-authored-by: Michel Heusschen <59014050+michelheusschen@users.noreply.github.com>
Co-authored-by: bo0tzz <git@bo0tzz.me>
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
Co-authored-by: Zack Pollard <zackpollard@ymail.com>

server/src/services/album.service.spec.ts

@@ -5,6 +5,7 @@ import { AlbumUserRole } from 'src/entities/album-user.entity';
 import { IAlbumUserRepository } from 'src/interfaces/album-user.interface';
 import { IAlbumRepository } from 'src/interfaces/album.interface';
 import { IAssetRepository } from 'src/interfaces/asset.interface';
+import { IJobRepository, JobName } from 'src/interfaces/job.interface';
 import { IUserRepository } from 'src/interfaces/user.interface';
 import { AlbumService } from 'src/services/album.service';
 import { albumStub } from 'test/fixtures/album.stub';
@@ -14,6 +15,7 @@ import { IAccessRepositoryMock, newAccessRepositoryMock } from 'test/repositorie
 import { newAlbumUserRepositoryMock } from 'test/repositories/album-user.repository.mock';
 import { newAlbumRepositoryMock } from 'test/repositories/album.repository.mock';
 import { newAssetRepositoryMock } from 'test/repositories/asset.repository.mock';
+import { newJobRepositoryMock } from 'test/repositories/job.repository.mock';
 import { newUserRepositoryMock } from 'test/repositories/user.repository.mock';
 import { Mocked } from 'vitest';
 
@@ -24,6 +26,7 @@ describe(AlbumService.name, () => {
   let assetMock: Mocked<IAssetRepository>;
   let userMock: Mocked<IUserRepository>;
   let albumUserMock: Mocked<IAlbumUserRepository>;
+  let jobMock: Mocked<IJobRepository>;
 
   beforeEach(() => {
     accessMock = newAccessRepositoryMock();
@@ -31,8 +34,9 @@ describe(AlbumService.name, () => {
     assetMock = newAssetRepositoryMock();
     userMock = newUserRepositoryMock();
     albumUserMock = newAlbumUserRepositoryMock();
+    jobMock = newJobRepositoryMock();
 
-    sut = new AlbumService(accessMock, albumMock, assetMock, userMock, albumUserMock);
+    sut = new AlbumService(accessMock, albumMock, assetMock, userMock, albumUserMock, jobMock);
   });
 
   it('should work', () => {
@@ -377,6 +381,14 @@ describe(AlbumService.name, () => {
         userId: authStub.user2.user.id,
         albumId: albumStub.sharedWithAdmin.id,
       });
+      expect(jobMock.queue.mock.calls).toEqual([
+        [
+          {
+            name: JobName.NOTIFY_ALBUM_INVITE,
+            data: { id: albumStub.sharedWithAdmin.id, recipientId: authStub.user2.user.id },
+          },
+        ],
+      ]);
     });
   });
 
@@ -561,6 +573,14 @@ describe(AlbumService.name, () => {
         albumThumbnailAssetId: 'asset-1',
       });
       expect(albumMock.addAssetIds).toHaveBeenCalledWith('album-123', ['asset-1', 'asset-2', 'asset-3']);
+      expect(jobMock.queue.mock.calls).toEqual([
+        [
+          {
+            name: JobName.NOTIFY_ALBUM_UPDATE,
+            data: { id: 'album-123', senderId: authStub.admin.user.id },
+          },
+        ],
+      ]);
     });
 
     it('should not set the thumbnail if the album has one already', async () => {
@@ -601,6 +621,14 @@ describe(AlbumService.name, () => {
         albumThumbnailAssetId: 'asset-1',
       });
       expect(albumMock.addAssetIds).toHaveBeenCalledWith('album-123', ['asset-1', 'asset-2', 'asset-3']);
+      expect(jobMock.queue.mock.calls).toEqual([
+        [
+          {
+            name: JobName.NOTIFY_ALBUM_UPDATE,
+            data: { id: 'album-123', senderId: authStub.user1.user.id },
+          },
+        ],
+      ]);
     });
 
     it('should not allow a shared user with viewer access to add assets', async () => {

server/src/services/album.service.ts

@@ -21,6 +21,7 @@ import { IAccessRepository } from 'src/interfaces/access.interface';
 import { IAlbumUserRepository } from 'src/interfaces/album-user.interface';
 import { AlbumAssetCount, AlbumInfoOptions, IAlbumRepository } from 'src/interfaces/album.interface';
 import { IAssetRepository } from 'src/interfaces/asset.interface';
+import { IJobRepository, JobName } from 'src/interfaces/job.interface';
 import { IUserRepository } from 'src/interfaces/user.interface';
 import { addAssets, removeAssets } from 'src/utils/asset.util';
 
@@ -33,6 +34,7 @@ export class AlbumService {
     @Inject(IAssetRepository) private assetRepository: IAssetRepository,
     @Inject(IUserRepository) private userRepository: IUserRepository,
     @Inject(IAlbumUserRepository) private albumUserRepository: IAlbumUserRepository,
+    @Inject(IJobRepository) private jobRepository: IJobRepository,
   ) {
     this.access = AccessCore.create(accessRepository);
   }
@@ -188,6 +190,11 @@ export class AlbumService {
       });
     }
 
+    await this.jobRepository.queue({
+      name: JobName.NOTIFY_ALBUM_UPDATE,
+      data: { id, senderId: auth.user.id },
+    });
+
     return results;
   }
 
@@ -234,6 +241,11 @@ export class AlbumService {
       }
 
       await this.albumUserRepository.create({ userId: userId, albumId: id, role });
+
+      await this.jobRepository.queue({
+        name: JobName.NOTIFY_ALBUM_INVITE,
+        data: { id: album.id, recipientId: user.id },
+      });
     }
 
     return this.findOrFail(id, { withAssets: true }).then(mapAlbumWithoutAssets);

server/src/services/microservices.service.ts

@@ -90,6 +90,8 @@ export class MicroservicesService {
       [JobName.LIBRARY_QUEUE_SCAN_ALL]: (data) => this.libraryService.handleQueueAllScan(data),
       [JobName.LIBRARY_QUEUE_CLEANUP]: () => this.libraryService.handleQueueCleanup(),
       [JobName.SEND_EMAIL]: (data) => this.notificationService.handleSendEmail(data),
+      [JobName.NOTIFY_ALBUM_INVITE]: (data) => this.notificationService.handleAlbumInvite(data),
+      [JobName.NOTIFY_ALBUM_UPDATE]: (data) => this.notificationService.handleAlbumUpdate(data),
       [JobName.NOTIFY_SIGNUP]: (data) => this.notificationService.handleUserSignup(data),
       [JobName.VERSION_CHECK]: () => this.versionService.handleVersionCheck(),
     });

server/src/services/notification.service.ts

@@ -1,10 +1,21 @@
 import { Inject, Injectable } from '@nestjs/common';
 import { SystemConfigCore } from 'src/cores/system-config.core';
 import { OnServerEvent } from 'src/decorators';
+import { AlbumEntity } from 'src/entities/album.entity';
+import { IAlbumRepository } from 'src/interfaces/album.interface';
+import { IAssetRepository } from 'src/interfaces/asset.interface';
 import { ServerAsyncEvent, ServerAsyncEventMap } from 'src/interfaces/event.interface';
-import { IEmailJob, IJobRepository, INotifySignupJob, JobName, JobStatus } from 'src/interfaces/job.interface';
+import {
+  IEmailJob,
+  IJobRepository,
+  INotifyAlbumInviteJob,
+  INotifyAlbumUpdateJob,
+  INotifySignupJob,
+  JobName,
+  JobStatus,
+} from 'src/interfaces/job.interface';
 import { ILoggerRepository } from 'src/interfaces/logger.interface';
-import { EmailTemplate, INotificationRepository } from 'src/interfaces/notification.interface';
+import { EmailImageAttachment, EmailTemplate, INotificationRepository } from 'src/interfaces/notification.interface';
 import { ISystemMetadataRepository } from 'src/interfaces/system-metadata.interface';
 import { IUserRepository } from 'src/interfaces/user.interface';
 
@@ -18,6 +29,8 @@ export class NotificationService {
     @Inject(IUserRepository) private userRepository: IUserRepository,
     @Inject(IJobRepository) private jobRepository: IJobRepository,
     @Inject(ILoggerRepository) private logger: ILoggerRepository,
+    @Inject(IAssetRepository) private assetRepository: IAssetRepository,
+    @Inject(IAlbumRepository) private albumRepository: IAlbumRepository,
   ) {
     this.logger.setContext(NotificationService.name);
     this.configCore = SystemConfigCore.create(systemMetadataRepository, logger);
@@ -70,6 +83,90 @@ export class NotificationService {
     return JobStatus.SUCCESS;
   }
 
+  async handleAlbumInvite({ id, recipientId }: INotifyAlbumInviteJob) {
+    const album = await this.albumRepository.getById(id, { withAssets: false });
+    if (!album) {
+      return JobStatus.SKIPPED;
+    }
+
+    const recipient = await this.userRepository.get(recipientId, { withDeleted: false });
+    if (!recipient) {
+      return JobStatus.SKIPPED;
+    }
+
+    const attachment = await this.getAlbumThumbnailAttachment(album);
+
+    const { server } = await this.configCore.getConfig();
+    const { html, text } = this.notificationRepository.renderEmail({
+      template: EmailTemplate.ALBUM_INVITE,
+      data: {
+        baseUrl: server.externalDomain || 'http://localhost:2283',
+        albumId: album.id,
+        albumName: album.albumName,
+        senderName: album.owner.name,
+        recipientName: recipient.name,
+        cid: attachment ? attachment.cid : undefined,
+      },
+    });
+
+    await this.jobRepository.queue({
+      name: JobName.SEND_EMAIL,
+      data: {
+        to: recipient.email,
+        subject: `You have been added to a shared album - ${album.albumName}`,
+        html,
+        text,
+        imageAttachments: attachment ? [attachment] : undefined,
+      },
+    });
+
+    return JobStatus.SUCCESS;
+  }
+
+  async handleAlbumUpdate({ id, senderId }: INotifyAlbumUpdateJob) {
+    const album = await this.albumRepository.getById(id, { withAssets: false });
+
+    if (!album) {
+      return JobStatus.SKIPPED;
+    }
+
+    const owner = await this.userRepository.get(album.ownerId, { withDeleted: false });
+    if (!owner) {
+      return JobStatus.SKIPPED;
+    }
+
+    const recipients = [...album.albumUsers.map((user) => user.user), owner].filter((user) => user.id !== senderId);
+    const attachment = await this.getAlbumThumbnailAttachment(album);
+
+    const { server } = await this.configCore.getConfig();
+
+    for (const recipient of recipients) {
+      const { html, text } = this.notificationRepository.renderEmail({
+        template: EmailTemplate.ALBUM_UPDATE,
+        data: {
+          baseUrl: server.externalDomain || 'http://localhost:2283',
+          albumId: album.id,
+          albumName: album.albumName,
+          recipientName: recipient.name,
+          cid: attachment ? attachment.cid : undefined,
+        },
+      });
+
+      await this.jobRepository.queue({
+        name: JobName.SEND_EMAIL,
+        data: {
+          to: recipient.email,
+          subject: `New media has been added to an album - ${album.albumName}`,
+          html,
+          text,
+          imageAttachments: attachment ? [attachment] : undefined,
+        },
+      });
+    }
+
+    return JobStatus.SUCCESS;
+  }
+
   async handleSendEmail(data: IEmailJob): Promise<JobStatus> {
     const { notifications } = await this.configCore.getConfig();
     if (!notifications.smtp.enabled) {
@@ -85,6 +182,7 @@ export class NotificationService {
       from: notifications.smtp.from,
       replyTo: notifications.smtp.replyTo || notifications.smtp.from,
       smtp: notifications.smtp.transport,
+      imageAttachments: data.imageAttachments,
     });
 
     if (!response) {
@@ -95,4 +193,21 @@ export class NotificationService {
 
     return JobStatus.SUCCESS;
   }
+
+  private async getAlbumThumbnailAttachment(album: AlbumEntity): Promise<EmailImageAttachment | undefined> {
+    if (!album.albumThumbnailAssetId) {
+      return;
+    }
+
+    const albumThumbnail = await this.assetRepository.getById(album.albumThumbnailAssetId);
+    if (!albumThumbnail?.thumbnailPath) {
+      return;
+    }
+
+    return {
+      filename: 'album-thumbnail.jpg',
+      path: albumThumbnail.thumbnailPath,
+      cid: 'album-thumbnail',
+    };
+  }
 }