Skip to main content

Error Notifications Worker

Sends daily reports about work items that have permanently failed (exhausted all retries).

Included in Base Preset

This plugin is part of the base preset and loaded automatically. Using the base preset is strongly recommended, so explicit installation is usually not required.

Installation​

import '@unchainedshop/plugins/worker/error-notifications';

Purpose​

The Error Notifications Worker helps you stay informed about system issues by:

  • Running automatically every day at 3 AM UTC
  • Collecting all permanently failed work items from the past 24 hours
  • Triggering a MESSAGE work item with the ERROR_REPORT template
  • Excluding its own failures to prevent notification loops

Auto-Scheduling​

When imported, this worker automatically schedules itself to run daily at 03:00 UTC.

Manual Trigger​

You can also trigger a report manually:

mutation SendErrorReport {
  createWork(
    type: "ERROR_NOTIFICATIONS"
    input: {
      secondsPassed: 86400  # Look back 24 hours (optional)
    }
  ) {
    _id
    status
  }
}

Input Parameters​

ParameterTypeDefaultDescription
secondsPassedNumber86400Seconds to look back for failed work items

Setting Up the Template​

To receive error notifications, you need to register an ERROR_REPORT template:

import { MessagingDirector } from '@unchainedshop/core';

MessagingDirector.registerTemplate('ERROR_REPORT', async ({ workItems }, context) => {
  const adminEmail = 'admin@example.com';

  const summary = workItems.map(work =>
    `- ${work.type}: ${work.error?.message || 'Unknown error'}`
  ).join('\n');

  return [{
    type: 'EMAIL',
    input: {
      to: adminEmail,
      subject: `[Unchained] ${workItems.length} failed work items`,
      text: `The following work items have permanently failed:\n\n${summary}`,
    },
  }];
});

Result​

{
  "forked": "message-work-id"  // ID of the created MESSAGE work
}

If no failed work items are found, the result will be empty and no message is sent.

Adapter Details​

PropertyValue
Keyshop.unchained.worker.error-notifications
TypeERROR_NOTIFICATIONS
Auto-ScheduleDaily at 03:00 UTC
Retries0
Sourceworker/error-notifications.ts