pg-transactional-outbox/src/message/mark-message-abandoned.ts

A PostgreSQL based transactional outbox and inbox pattern implementation to support exactly once message processing (with at least once message delivery).

import { DatabaseClient } from '../common/database';
import { ListenerConfig } from '../common/listener-config';
import { StoredTransactionalMessage } from './transactional-message';

/**
 * Marks the message as abandoned by setting the abandoned_at date to the current date and time.
 * @param message The message to mark as abandoned.
 * @param client The database client. Must be part of the transaction where the error handling changes are done.
 * @param config The configuration settings that defines database schema.
 */
export const markMessageAbandoned = async (
  { id }: StoredTransactionalMessage,
  client: DatabaseClient,
  { settings }: Pick<ListenerConfig, 'settings'>,
): Promise<void> => {
  await client.query(
    /* sql */ `UPDATE ${settings.dbSchema}.${settings.dbTable} SET abandoned_at = clock_timestamp(), finished_attempts = finished_attempts + 1 WHERE id = $1;`,
    [id],
  );
};