upstream-twenty/packages/twenty-server/test/integration/workflow-actions/draft-email/drivers/imap-smtp.integration-spec.ts

import { randomUUID } from 'node:crypto';

import { isNonEmptyString } from '@sniptt/guards';
import { ImapFlow } from 'imapflow';

import { EmailConnectionSecurity } from 'src/engine/core-modules/imap-smtp-caldav-connection/enums/email-connection-security.enum';
import { MessageChannelEntity } from 'src/engine/metadata-modules/message-channel/entities/message-channel.entity';

import { runWorkflowActionStep } from 'test/integration/graphql/suites/workflow/utils/run-workflow-action-step.util';
import { deleteConnectedAccount } from 'test/integration/metadata/suites/connected-account/utils/delete-connected-account.util';
import { saveImapSmtpCaldavAccount } from 'test/integration/metadata/suites/connected-account/utils/save-imap-smtp-caldav-account.util';
import { updateConfigVariable } from 'test/integration/twenty-config/utils/update-config-variable.util';
import { findRecordNodesByFilter } from 'test/integration/utils/find-records-by-filter.util';
import { getCoreRepository } from 'test/integration/utils/get-core-repository.util';
import { runMessageChannelSync } from 'test/integration/utils/run-message-channel-sync.util';
import {
  type GreenmailServer,
  startGreenmailContainer,
} from 'test/integration/utils/start-greenmail-container.util';

const PASSWORD = 'greenmail-password';
const HANDLE = `imap-draft-email-action-${randomUUID()}@acme.test`;

describe('DRAFT_EMAIL workflow action on IMAP (integration)', () => {
  let greenmail: GreenmailServer;
  let connectedAccountId: string;
  let messageChannelId: string;

  const findDrafts = async (): Promise<
    { subject: string; source: string }[]
  > => {
    const client = new ImapFlow({
      host: greenmail.host,
      port: greenmail.imapPort,
      secure: false,
      auth: { user: HANDLE.split('@')[0], pass: PASSWORD },
      logger: false,
    });

    await client.connect();

    try {
      const { exists } = await client.mailboxOpen('Drafts');

      if (exists === 0) {
        return [];
      }

      const drafts: { subject: string; source: string }[] = [];

      for await (const message of client.fetch('1:*', {
        envelope: true,
        source: true,
      })) {
        const subject = message.envelope?.subject;

        if (isNonEmptyString(subject)) {
          drafts.push({
            subject,
            source: message.source?.toString('latin1') ?? '',
          });
        }
      }

      return drafts;
    } finally {
      await client.logout();
    }
  };

  beforeAll(async () => {
    await updateConfigVariable({
      input: { key: 'OUTBOUND_HTTP_ALLOWED_INTERNAL_HOSTS', value: ['*'] },
    });

    greenmail = await startGreenmailContainer({
      username: HANDLE,
      password: PASSWORD,
    });

    const { data } = await saveImapSmtpCaldavAccount({
      input: {
        handle: HANDLE,
        connectionParameters: {
          IMAP: {
            host: greenmail.host,
            port: greenmail.imapPort,
            username: HANDLE.split('@')[0],
            password: PASSWORD,
            connectionSecurity: EmailConnectionSecurity.NONE,
          },
          SMTP: {
            host: greenmail.host,
            port: greenmail.smtpPort,
            username: HANDLE.split('@')[0],
            password: PASSWORD,
            connectionSecurity: EmailConnectionSecurity.NONE,
          },
        },
      },
      expectToFail: false,
    });

    connectedAccountId = data.connectedAccountId;
    messageChannelId = (
      await getCoreRepository<MessageChannelEntity>(
        MessageChannelEntity,
      ).findOneByOrFail({ connectedAccountId })
    ).id;

    await runMessageChannelSync(messageChannelId);
  }, 300000);

  afterAll(async () => {
    await updateConfigVariable({
      input: { key: 'OUTBOUND_HTTP_ALLOWED_INTERNAL_HOSTS', value: [] },
    }).catch(() => undefined);

    if (isNonEmptyString(connectedAccountId)) {
      await deleteConnectedAccount({
        id: connectedAccountId,
        expectToFail: false,
      }).catch(() => undefined);
    }

    await greenmail?.stop().catch(() => undefined);
  });

  it('appends a draft to the drafts folder without persisting it', async () => {
    const subject = `IMAP/SMTP workflow draft ${randomUUID()}`;

    const workflowRun = await runWorkflowActionStep({
      name: 'IMAP/SMTP draft email workflow',
      stepType: 'DRAFT_EMAIL',
      input: {
        connectedAccountId,
        recipients: { to: '{{trigger.to}}' },
        subject: '{{trigger.subject}}',
        body: '<p>SMTP workflow draft body</p>',
      },
      payload: { to: HANDLE, subject },
    });

    expect(workflowRun).toMatchObject({
      status: 'COMPLETED',
      stepStatus: 'SUCCESS',
    });
    expect(workflowRun.stepResult).toMatchObject({
      recipients: [HANDLE],
      subject,
      connectedAccountId,
    });
    expect(await findDrafts()).toContainEqual(
      expect.objectContaining({ subject }),
    );
    expect(
      await findRecordNodesByFilter<{ id: string }>(
        'message',
        'messages',
        'id',
        { subject: { eq: subject } },
      ),
    ).toEqual([]);
  }, 300000);

  it('appends a multi-paragraph draft with CRLF line endings only', async () => {
    const subject = `IMAP/SMTP multi-paragraph draft ${randomUUID()}`;

    const workflowRun = await runWorkflowActionStep({
      name: 'IMAP/SMTP multi-paragraph draft email workflow',
      stepType: 'DRAFT_EMAIL',
      input: {
        connectedAccountId,
        recipients: { to: '{{trigger.to}}' },
        subject: '{{trigger.subject}}',
        body: '<p>First paragraph</p><p>Second paragraph</p>',
      },
      payload: { to: HANDLE, subject },
    });

    expect(workflowRun).toMatchObject({
      status: 'COMPLETED',
      stepStatus: 'SUCCESS',
    });

    const draft = (await findDrafts()).find(
      (candidate) => candidate.subject === subject,
    );

    expect(draft?.source).toContain('First paragraph\r\n\r\nSecond paragraph');
    expect(draft?.source).not.toMatch(/[^\r]\n/);
  }, 300000);
});