Использование шаблона завода для управления различными каналами уведомлений в продукте SaaS

Введение: проблема уведомлений в SaaS

Современные продукты SaaS полагаются на своевременные персонализированные уведомления для привлечения пользователей, удержания диска и передачи критических событий системы. Пользователи ожидают получать оповещения по своим предпочтительным каналам - электронной почте, SMS, push-уведомлениям, сообщениям в приложении или даже веб-хукам к сторонним службам. По мере развития продукта количество каналов растет, и управление ими через разрозненную условную логику становится кошмаром обслуживания. Нужна чистая, масштабируемая архитектура.

Directus, бесшовная CMS с открытым исходным кодом и бэкэнд-платформа, обеспечивает гибкую основу для создания приложений SaaS. Его модель данных, движок Flows и расширяемые крючки делают его идеальной средой для реализации надежной системы уведомлений. Применяя классический шаблон креационного дизайна - Factory Pattern - вы можете инкапсулировать логику создания, специфичную для канала, отделить свой основной бизнес-код от деталей доставки и легко добавлять новые каналы по мере созревания вашего продукта.

Понимание структуры завода

Фабричный шаблон - это шаблон креационного дизайна, который обеспечивает интерфейс для создания объектов в суперклассе, но позволяет подклассам изменять тип объектов, которые будут созданы. Он способствует свободной связи и придерживается открытого / закрытого принципа: программные объекты должны быть открыты для расширения, но закрыты для модификации. Вместо того, чтобы засорять ваше приложение заявлениями или , чтобы решить, какой объект уведомления инстанцировать, вы делегируете эту ответственность специализированной фабрике.

Этот шаблон сияет, когда у вас есть семейство связанных объектов, и точный тип для инстанцирования определяется во время выполнения на основе динамического ввода, такого как предпочтения уведомления пользователя или запускаемое событие. В контексте уведомления каждый канал является различным «продуктом», но все они имеют общий интерфейс (например, метод [[FLT: 2]]).

Каналы уведомлений в SaaS-продукте

Общие каналы уведомлений включают:

• Электронная почта — транзакционные и маркетинговые электронные письма через такие службы, как SendGrid или Mailgun.
• SMS — короткие сообщения через Twilio или Vonage.
• Push Notifications — веб-толчок, мобильный толчок через Firebase Cloud Messaging или OneSignal.
• Уведомления в приложении — тосты пользовательского интерфейса или оповещения панели инструментов.
• Webhooks — HTTP POST-запросы на внешние конечные точки для интеграции.
• Слабость / разлад — командно-ориентированный обмен сообщениями.

Без шаблона ваш код может выглядеть так:

function sendNotification(channel, message, recipient) {
 if (channel === 'email') {
 // Email logic here
 } else if (channel === 'sms') {
 // SMS logic here
 } else if (channel === 'push') {
 // Push logic here
 } else {
 throw new Error('Unknown channel');
 }
}

Этот подход работает для нескольких каналов, но каждый новый канал заставляет вас изменять функцию отправки и перепроверять всю существующую логику.

Реализация фабричного шаблона уведомлений

Ниже мы рассмотрим реализацию TypeScript, которая может быть адаптирована для SaaS на основе Directus. TypeScript является естественным для Directus, потому что сама платформа построена с ним и обеспечивает богатую систему типов.

1.Определить интерфейс уведомлений

interface Notification {
 send(message: string, recipient: string): Promise<void>
}

2.Бетонные классы уведомлений

class EmailNotification implements Notification {
 async send(message: string, recipient: string): Promise<void> {
 // Use Directus’s internal mailer or an external SDK
 console.log(`Sending email to ${recipient}: ${message}`);
 }
}

class SMSNotification implements Notification {
 async send(message: string, recipient: string): Promise<void> {
 // Call Twilio API
 console.log(`Sending SMS to ${recipient}: ${message}`);
 }
}

class PushNotification implements Notification {
 async send(message: string, recipient: string): Promise<void> {
 // Use Firebase or OneSignal SDK
 console.log(`Sending push to ${recipient}: ${message}`);
 }
}

3. Фабрика уведомлений

type ChannelType = 'email' | 'sms' | 'push';

class NotificationFactory {
 static createNotification(channel: ChannelType): Notification {
 switch (channel) {
 case 'email':
 return new EmailNotification();
 case 'sms':
 return new SMSNotification();
 case 'push':
 return new PushNotification();
 default:
 throw new Error(`Unknown notification channel: ${channel}`);
 }
 }
}

4.Использование фабрики в вашем приложении

async function notifyUser(event: string, userId: string, channel: ChannelType) {
 const notification = NotificationFactory.createNotification(channel);
 await notification.send(event, userId);
}

Клиентский код никогда не должен знать конкретный тип. Он зависит только от интерфейса . Это разделение делает тестирование блоков простым — вы можете высмеивать объект уведомления, не касаясь завода или конкретных классов.

Интеграция фабричного шаблона с Directus

Directus предлагает несколько точек входа для запуска уведомлений:

• FLT:0 Потоки FLT:1 — визуальная автоматизация, которая может вызывать пользовательские операции или веб-хуки.
• Чуки — или крючки, которые работают на событиях CRUD.
• Пользовательские конечные точки — Экспресс-маршруты, вводимые в сервер Directus.
• Webhooks — Уходящие диспетчеры веб-хуков.

В проекте Directus вы можете установить завод уведомлений в качестве службы внутри пользовательского модуля или расширения. Например, внутри FLT:0]Flow вы можете вызвать внутреннюю конечную точку API, которая инстанцирует правильный канал на основе сохраненных предпочтений пользователя. Альтернативно, вы можете обернуть завод в крюк ], который загорается после новой регистрации пользователя и отправляет приветственное электронное письмо, подтверждение SMS и push-уведомление в мобильное приложение.

import { NotificationFactory } from './services/NotificationFactory';

async function onTaskCreate(payload, { accountability }) {
 const { assigneeId } = payload;
 const userPreferences = await getUserNotificationPreferences(assigneeId);
 for (const channel of userPreferences.channels) {
 const notifier = NotificationFactory.createNotification(channel);
 await notifier.send(`You have a new task!`, assigneeId);
 }
}