@stamhoofd/models 2.91.0 → 2.93.0

package/src/models/Email.test.ts

@@ -2,7 +2,7 @@ import { EmailRecipientFilter, EmailRecipientFilterType, EmailRecipientsStatus,
 import { Email } from './Email';
 import { EmailRecipient } from './EmailRecipient';
 import { EmailMocker } from '@stamhoofd/email';
-import { TestUtils } from '@stamhoofd/test-utils';
+import { STExpect, TestUtils } from '@stamhoofd/test-utils';
 import { OrganizationFactory } from '../factories/OrganizationFactory';
 import { Platform } from './Platform';
 
@@ -50,6 +50,48 @@ async function buildEmail(data: {
     return model;
 }
 
+/**
+ * An email that won't be able to fetch recipients
+ */
+async function buildFailEmail(data: {
+    recipients: EmailRecipientStruct[];
+} & Partial<Email>) {
+    Email.recipientLoaders.set(EmailRecipientFilterType.Members, {
+        fetch: async (query: LimitedFilteredRequest) => {
+            throw new Error('This is a simulated error while fetching recipients');
+        },
+
+        count: async (query: LimitedFilteredRequest) => {
+            return data.recipients.length;
+        },
+    });
+
+    const model = new Email();
+    model.userId = null;
+    model.organizationId = data.organizationId ?? null;
+    model.recipientFilter = EmailRecipientFilter.create({
+        filters: [
+            EmailRecipientSubfilter.create({
+                type: EmailRecipientFilterType.Members,
+                filter: { id: { $in: ['test'] } },
+            }),
+        ],
+    });
+
+    model.subject = data.subject ?? 'This is a test email';
+    model.html = data.html ?? '<p>This is a test email</p>';
+    model.text = data.text ?? 'This is a test email';
+    model.json = data.json ?? {};
+    model.status = data.status ?? EmailStatus.Draft;
+    model.attachments = [];
+    model.fromAddress = data.fromAddress ?? 'test@stamhoofd.be';
+    model.fromName = data.fromName ?? null;
+
+    await model.save();
+
+    return model;
+}
+
 describe('Model.Email', () => {
     it('Correctly whitelists email recipients', async () => {
         TestUtils.setEnvironment('WHITELISTED_EMAIL_DESTINATIONS', ['*@stamhoofd-allowed-domain-tests.be']);
@@ -67,12 +109,16 @@ describe('Model.Email', () => {
                 }),
             ],
         });
-        await model.send();
+        await model.queueForSending(true);
         await model.refresh();
 
         // Check if it was sent correctly
         expect(model.recipientsStatus).toBe(EmailRecipientsStatus.Created);
-        expect(model.recipientCount).toBe(2);
+        expect(model.emailRecipientsCount).toBe(2);
+        expect(model.succeededCount).toBe(1);
+        expect(model.failedCount).toBe(1);
+        expect(model.emailErrors).toBe(null);
+        expect(model.recipientsErrors).toBe(null);
         expect(model.status).toBe(EmailStatus.Sent);
         expect(await EmailMocker.broadcast.getSucceededCount()).toBe(1);
         expect(await EmailMocker.broadcast.getFailedCount()).toBe(0); // never tried to send any failed emails (whitelist)
@@ -119,13 +165,16 @@ describe('Model.Email', () => {
         // It should automatically retry to send the email
         EmailMocker.broadcast.failNext(new Error('This is a simulated network error'));
 
-        await model.send();
+        await model.queueForSending(true);
         await model.refresh();
 
         // Check if it was sent correctly
         expect(model.recipientsStatus).toBe(EmailRecipientsStatus.Created);
-        expect(model.recipientCount).toBe(2);
+        expect(model.emailRecipientsCount).toBe(2);
         expect(model.status).toBe(EmailStatus.Sent);
+        expect(model.succeededCount).toBe(2);
+        expect(model.failedCount).toBe(0);
+        expect(model.softFailedCount).toBe(0);
 
         // Both have succeeded
         expect(await EmailMocker.broadcast.getSucceededCount()).toBe(2);
@@ -147,6 +196,43 @@ describe('Model.Email', () => {
         ]);
     }, 15_000);
 
+    it('Email changes to failed state if email recipients fails to build', async () => {
+        const model = await buildFailEmail({
+            recipients: [
+                EmailRecipientStruct.create({
+                    firstName: 'Test',
+                    lastName: 'Test',
+                    email: 'example@domain.be',
+                }),
+                EmailRecipientStruct.create({
+                    firstName: 'Test',
+                    lastName: 'Test',
+                    email: 'example2@domain.be',
+                }),
+            ],
+        });
+
+        await expect(model.queueForSending(true)).toReject();
+        await model.refresh();
+
+        // Check if it was sent correctly
+        expect(model.recipientsStatus).toBe(EmailRecipientsStatus.NotCreated);
+        expect(model.recipientsErrors).toEqual(STExpect.simpleErrors([{
+            code: 'unknown_error',
+            message: 'This is a simulated error while fetching recipients',
+        }]));
+
+        expect(model.emailRecipientsCount).toBe(null);
+        expect(model.status).toBe(EmailStatus.Failed);
+        expect(model.succeededCount).toBe(0);
+        expect(model.failedCount).toBe(0);
+        expect(model.softFailedCount).toBe(0);
+
+        // Both have succeeded
+        expect(await EmailMocker.broadcast.getSucceededCount()).toBe(0);
+        expect(await EmailMocker.broadcast.getFailedCount()).toBe(0); // One retry
+    }, 15_000);
+
     it('Marks email recipient as failed if fails three times', async () => {
         const model = await buildEmail({
             recipients: [
@@ -163,8 +249,6 @@ describe('Model.Email', () => {
             ],
         });
 
-        // Only one failure (the first email)
-        // It should automatically retry to send the email
         EmailMocker.broadcast.failNext(new Error('This is a simulated network error 1'));
         EmailMocker.broadcast.failNext(new Error('This is a simulated network error 2'));
         EmailMocker.broadcast.failNext(new Error('This is a simulated network error 3'));
@@ -172,13 +256,16 @@ describe('Model.Email', () => {
         EmailMocker.broadcast.failNext(new Error('This is a simulated network error 5'));
         EmailMocker.broadcast.failNext(new Error('This is a simulated network error 6'));
 
-        await model.send();
+        await model.queueForSending(true);
         await model.refresh();
 
         // Check if it was sent correctly
         expect(model.recipientsStatus).toBe(EmailRecipientsStatus.Created);
-        expect(model.recipientCount).toBe(2);
+        expect(model.emailRecipientsCount).toBe(2);
         expect(model.status).toBe(EmailStatus.Sent);
+        expect(model.succeededCount).toBe(0);
+        expect(model.failedCount).toBe(2);
+        expect(model.softFailedCount).toBe(0);
 
         // Both have succeeded
         expect(await EmailMocker.broadcast.getSucceededCount()).toBe(0);
@@ -191,6 +278,9 @@ describe('Model.Email', () => {
                 email: 'example@domain.be',
                 sentAt: null,
                 failCount: 1,
+                failError: STExpect.simpleErrors([{
+                    message: /This is a simulated network error (3|6)/,
+                }]),
                 firstFailedAt: expect.any(Date),
                 lastFailedAt: expect.any(Date),
             }),
@@ -198,6 +288,9 @@ describe('Model.Email', () => {
                 email: 'example2@domain.be',
                 sentAt: null,
                 failCount: 1,
+                failError: STExpect.simpleErrors([{
+                    message: /This is a simulated network error (3|6)/,
+                }]),
                 firstFailedAt: expect.any(Date),
                 lastFailedAt: expect.any(Date),
             }),
@@ -213,13 +306,16 @@ describe('Model.Email', () => {
             ],
         });
 
-        await model.send();
+        await model.queueForSending(true);
         await model.refresh();
 
         // Check if it was sent correctly
         expect(model.recipientsStatus).toBe(EmailRecipientsStatus.Created);
-        expect(model.recipientCount).toBe(1);
+        expect(model.emailRecipientsCount).toBe(1);
         expect(model.status).toBe(EmailStatus.Sent);
+        expect(model.succeededCount).toBe(1);
+        expect(model.failedCount).toBe(0);
+        expect(model.softFailedCount).toBe(0);
 
         // Both have succeeded
         expect(await EmailMocker.broadcast.getSucceededCount()).toBe(1);
@@ -236,7 +332,7 @@ describe('Model.Email', () => {
         ]);
 
         // Check to header
-        expect(await EmailMocker.broadcast.getSucceededEmail(0).to).toEqual('example@domain.be');
+        expect(EmailMocker.broadcast.getSucceededEmail(0).to).toEqual('example@domain.be');
     }, 15_000);
 
     it('Includes recipient names in mail header', async () => {
@@ -250,13 +346,16 @@ describe('Model.Email', () => {
             ],
         });
 
-        await model.send();
+        await model.queueForSending(true);
         await model.refresh();
 
         // Check if it was sent correctly
         expect(model.recipientsStatus).toBe(EmailRecipientsStatus.Created);
-        expect(model.recipientCount).toBe(1);
+        expect(model.emailRecipientsCount).toBe(1);
         expect(model.status).toBe(EmailStatus.Sent);
+        expect(model.succeededCount).toBe(1);
+        expect(model.failedCount).toBe(0);
+        expect(model.softFailedCount).toBe(0);
 
         // Both have succeeded
         expect(await EmailMocker.broadcast.getSucceededCount()).toBe(1);
@@ -275,7 +374,7 @@ describe('Model.Email', () => {
         ]);
 
         // Check to header
-        expect(await EmailMocker.broadcast.getSucceededEmail(0).to).toEqual('"John Von Doe" <example@domain.be>');
+        expect(EmailMocker.broadcast.getSucceededEmail(0).to).toEqual('"John Von Doe" <example@domain.be>');
     }, 15_000);
 
     it('Skips invalid email addresses', async () => {
@@ -289,13 +388,16 @@ describe('Model.Email', () => {
             ],
         });
 
-        await model.send();
+        await model.queueForSending(true);
         await model.refresh();
 
         // Check if it was sent correctly
         expect(model.recipientsStatus).toBe(EmailRecipientsStatus.Created);
-        expect(model.recipientCount).toBe(1);
+        expect(model.emailRecipientsCount).toBe(1);
         expect(model.status).toBe(EmailStatus.Sent);
+        expect(model.succeededCount).toBe(0);
+        expect(model.failedCount).toBe(1);
+        expect(model.softFailedCount).toBe(0);
 
         // Both have succeeded
         expect(await EmailMocker.broadcast.getSucceededCount()).toBe(0);
@@ -309,7 +411,10 @@ describe('Model.Email', () => {
                 lastName: 'Von Doe',
                 email: 'invalid',
                 failCount: 1,
-                failErrorMessage: 'Invalid email address',
+                failError: STExpect.simpleErrors([{
+                    code: 'invalid_email_address',
+                    message: 'Invalid email address',
+                }]),
                 firstFailedAt: expect.any(Date),
                 lastFailedAt: expect.any(Date),
             }),
@@ -332,13 +437,16 @@ describe('Model.Email', () => {
             ],
         });
 
-        await model.send();
+        await model.queueForSending(true);
         await model.refresh();
 
         // Check if it was sent correctly
         expect(model.recipientsStatus).toBe(EmailRecipientsStatus.Created);
-        expect(model.recipientCount).toBe(1);
+        expect(model.emailRecipientsCount).toBe(1);
         expect(model.status).toBe(EmailStatus.Sent);
+        expect(model.succeededCount).toBe(1);
+        expect(model.failedCount).toBe(0);
+        expect(model.softFailedCount).toBe(0);
 
         // Both have succeeded
         expect(await EmailMocker.broadcast.getSucceededCount()).toBe(1);
@@ -350,6 +458,7 @@ describe('Model.Email', () => {
             expect.objectContaining({
                 email: 'valid@example.com',
                 sentAt: expect.any(Date),
+                failError: null,
             }),
         ]);
     }, 15_000);
@@ -375,20 +484,23 @@ describe('Model.Email', () => {
             fromName: 'My Platform',
         });
 
-        await model.send();
+        await model.queueForSending(true);
         await model.refresh();
 
         // Check if it was sent correctly
         expect(model.recipientsStatus).toBe(EmailRecipientsStatus.Created);
-        expect(model.recipientCount).toBe(1);
+        expect(model.emailRecipientsCount).toBe(1);
         expect(model.status).toBe(EmailStatus.Sent);
+        expect(model.succeededCount).toBe(1);
+        expect(model.failedCount).toBe(0);
+        expect(model.softFailedCount).toBe(0);
 
         // Both have succeeded
         expect(await EmailMocker.broadcast.getSucceededCount()).toBe(1);
         expect(await EmailMocker.broadcast.getFailedCount()).toBe(0);
 
         // Check to header
-        expect(await EmailMocker.broadcast.getSucceededEmail(0)).toMatchObject({
+        expect(EmailMocker.broadcast.getSucceededEmail(0)).toMatchObject({
             to: 'example@domain.be',
             from: '"My Platform" <info@my-platform.com>',
             replyTo: undefined,
@@ -416,20 +528,23 @@ describe('Model.Email', () => {
             fromName: 'My Platform',
         });
 
-        await model.send();
+        await model.queueForSending(true);
         await model.refresh();
 
         // Check if it was sent correctly
         expect(model.recipientsStatus).toBe(EmailRecipientsStatus.Created);
-        expect(model.recipientCount).toBe(1);
+        expect(model.emailRecipientsCount).toBe(1);
         expect(model.status).toBe(EmailStatus.Sent);
+        expect(model.succeededCount).toBe(1);
+        expect(model.failedCount).toBe(0);
+        expect(model.softFailedCount).toBe(0);
 
         // Both have succeeded
         expect(await EmailMocker.broadcast.getSucceededCount()).toBe(1);
         expect(await EmailMocker.broadcast.getFailedCount()).toBe(0);
 
         // Check to header
-        expect(await EmailMocker.broadcast.getSucceededEmail(0)).toMatchObject({
+        expect(EmailMocker.broadcast.getSucceededEmail(0)).toMatchObject({
             to: 'example@domain.be',
             from: '"My Platform" <noreply@broadcast.my-platform.com>', // domain has changed here
             replyTo: '"My Platform" <info@other-platform.com>', // Reply to should be set
@@ -462,20 +577,23 @@ describe('Model.Email', () => {
             fromName: 'My Platform',
         });
 
-        await model.send();
+        await model.queueForSending(true);
         await model.refresh();
 
         // Check if it was sent correctly
         expect(model.recipientsStatus).toBe(EmailRecipientsStatus.Created);
-        expect(model.recipientCount).toBe(1);
+        expect(model.emailRecipientsCount).toBe(1);
         expect(model.status).toBe(EmailStatus.Sent);
+        expect(model.succeededCount).toBe(1);
+        expect(model.failedCount).toBe(0);
+        expect(model.softFailedCount).toBe(0);
 
         // Both have succeeded
         expect(await EmailMocker.broadcast.getSucceededCount()).toBe(1);
         expect(await EmailMocker.broadcast.getFailedCount()).toBe(0);
 
         // Check to header
-        expect(await EmailMocker.broadcast.getSucceededEmail(0)).toMatchObject({
+        expect(EmailMocker.broadcast.getSucceededEmail(0)).toMatchObject({
             to: 'example@domain.be',
             from: '"My Platform" <noreply-uritest@broadcast.my-platform.com>', // domain has changed here
             replyTo: '"My Platform" <info@my-platform.com>', // Reply to should be set
@@ -510,20 +628,23 @@ describe('Model.Email', () => {
             fromName: 'My Platform',
         });
 
-        await model.send();
+        await model.queueForSending(true);
         await model.refresh();
 
         // Check if it was sent correctly
         expect(model.recipientsStatus).toBe(EmailRecipientsStatus.Created);
-        expect(model.recipientCount).toBe(1);
+        expect(model.emailRecipientsCount).toBe(1);
         expect(model.status).toBe(EmailStatus.Sent);
+        expect(model.succeededCount).toBe(1);
+        expect(model.failedCount).toBe(0);
+        expect(model.softFailedCount).toBe(0);
 
         // Both have succeeded
         expect(await EmailMocker.broadcast.getSucceededCount()).toBe(1);
         expect(await EmailMocker.broadcast.getFailedCount()).toBe(0);
 
         // Check to header
-        expect(await EmailMocker.broadcast.getSucceededEmail(0)).toMatchObject({
+        expect(EmailMocker.broadcast.getSucceededEmail(0)).toMatchObject({
             to: 'example@domain.be',
             from: '"My Platform" <info@my-platform.com>', // domain has changed here
             replyTo: undefined,
@@ -558,12 +679,12 @@ describe('Model.Email', () => {
                 subject: '{{fromAddress}}',
             });
 
-            await model.send();
+            await model.queueForSending(true);
             await model.refresh();
 
             // Check if it was sent correctly
             expect(model.recipientsStatus).toBe(EmailRecipientsStatus.Created);
-            expect(model.recipientCount).toBe(1);
+            expect(model.emailRecipientsCount).toBe(1);
             expect(model.status).toBe(EmailStatus.Sent);
 
             // Both have succeeded
@@ -571,7 +692,7 @@ describe('Model.Email', () => {
             expect(await EmailMocker.broadcast.getFailedCount()).toBe(0);
 
             // Check to header
-            expect(await EmailMocker.broadcast.getSucceededEmail(0)).toMatchObject({
+            expect(EmailMocker.broadcast.getSucceededEmail(0)).toMatchObject({
                 to: 'example@domain.be',
                 from: '"Custom Name" <noreply-' + organization.uri + '@broadcast.my-platform.com>',
                 replyTo: '"Custom Name" <custom@customdomain.com>', // domain has changed here
@@ -614,12 +735,12 @@ describe('Model.Email', () => {
                 subject: '{{primaryColor}};{{primaryColorContrast}};{{organizationName}};{{fromName}}',
             });
 
-            await model.send();
+            await model.queueForSending(true);
             await model.refresh();
 
             // Check if it was sent correctly
             expect(model.recipientsStatus).toBe(EmailRecipientsStatus.Created);
-            expect(model.recipientCount).toBe(1);
+            expect(model.emailRecipientsCount).toBe(1);
             expect(model.status).toBe(EmailStatus.Sent);
 
             // Both have succeeded
@@ -627,7 +748,7 @@ describe('Model.Email', () => {
             expect(await EmailMocker.broadcast.getFailedCount()).toBe(0);
 
             // Check to header
-            expect(await EmailMocker.broadcast.getSucceededEmail(0)).toMatchObject({
+            expect(EmailMocker.broadcast.getSucceededEmail(0)).toMatchObject({
                 subject: `${brightYellow};${expectedContrastColor};${organization.name};${organization.name}`,
                 html: `${brightYellow};${expectedContrastColor};${organization.name};${organization.name}`,
                 text: `${brightYellow};${expectedContrastColor};${organization.name};${organization.name}`,
@@ -672,12 +793,12 @@ describe('Model.Email', () => {
                 subject: '{{primaryColor}};{{primaryColorContrast}};{{organizationName}};{{fromName}}',
             });
 
-            await model.send();
+            await model.queueForSending(true);
             await model.refresh();
 
             // Check if it was sent correctly
             expect(model.recipientsStatus).toBe(EmailRecipientsStatus.Created);
-            expect(model.recipientCount).toBe(1);
+            expect(model.emailRecipientsCount).toBe(1);
             expect(model.status).toBe(EmailStatus.Sent);
 
             // Both have succeeded
@@ -685,7 +806,7 @@ describe('Model.Email', () => {
             expect(await EmailMocker.broadcast.getFailedCount()).toBe(0);
 
             // Check to header
-            expect(await EmailMocker.broadcast.getSucceededEmail(0)).toMatchObject({
+            expect(EmailMocker.broadcast.getSucceededEmail(0)).toMatchObject({
                 subject: `${brightBlue};${expectedContrastColor};${organization.name};Custom Name`,
                 html: `${brightBlue};${expectedContrastColor};${organization.name};Custom Name`,
                 text: `${brightBlue};${expectedContrastColor};${organization.name};Custom Name`,
@@ -722,12 +843,12 @@ describe('Model.Email', () => {
                 subject: '{{primaryColor}};{{primaryColorContrast}};{{organizationName}};{{fromName}}',
             });
 
-            await model.send();
+            await model.queueForSending(true);
             await model.refresh();
 
             // Check if it was sent correctly
             expect(model.recipientsStatus).toBe(EmailRecipientsStatus.Created);
-            expect(model.recipientCount).toBe(1);
+            expect(model.emailRecipientsCount).toBe(1);
             expect(model.status).toBe(EmailStatus.Sent);
 
             // Both have succeeded
@@ -735,7 +856,7 @@ describe('Model.Email', () => {
             expect(await EmailMocker.broadcast.getFailedCount()).toBe(0);
 
             // Check to header
-            expect(await EmailMocker.broadcast.getSucceededEmail(0)).toMatchObject({
+            expect(EmailMocker.broadcast.getSucceededEmail(0)).toMatchObject({
                 subject: `${darkRed};${expectedContrastColor};${platform.config.name};${platform.config.name}`,
                 html: `${darkRed};${expectedContrastColor};${platform.config.name};${platform.config.name}`,
                 text: `${darkRed};${expectedContrastColor};${platform.config.name};${platform.config.name}`,