Upgrade to @forge/events major version 2

Event publishing

Breaking changes

The signature of Queue.push() has changed, with the parameter type PushEvent now containing body and delayInSeconds. The event body must be an object.

@forge/events 1.x

1
2
type Payload = string | number | boolean | { [key: string]: Payload };
type PushSettings = { delayInSeconds: number };

await queue.push(Payload | Payload[], PushSettings);

@forge/events 2.0.0

1
2
export type Body = Record<string, unknown>;
export interface PushEvent {
    body: Body;
    delayInSeconds?: number;
}

const result: PushResult = await queue.push(PushEvent | PushEvent[]);

Event consumption

Breaking changes

Forge resolvers are no longer used. The Consumer module instead requires a Function.

Consumer functions are invoked with an AsyncEvent, which contains the fields of PushEvent as well as invocation-specific fields, including jobId and retryContext. jobId is no longer available via context. retryContext is no longer added to the event body.

@forge/events 1.x

1
2
modules:
  consumer:
    - key: queue-consumer
      # Name of the queue for which this consumer will be invoked
      queue: queue-name
      resolver:
        function: consumer-function
        # resolver function to be called with payload
        method: event-listener
  function:
    - key: consumer-function
      handler: consumer.handler
      timeoutSeconds: 600

1
2
import Resolver from '@forge/resolver';
const resolver = new Resolver();

resolver.define('event-listener', async ({ payload, context }) => {
    // process the event
});

export const handler = resolver.getDefinitions();

@forge/events 2.0.0

1
2
modules:
  consumer:
    - key: queue-consumer
      # Name of the queue for which this consumer will be invoked
      queue: queue-name
      # Function to be called with payload
      function: consumer-function
  function:
    - key: consumer-function
      handler: consumer.handler
      timeoutSeconds: 600

1
2
import { AsyncEvent } from '@forge/events';

export async function handler(event: AsyncEvent, context) {
    // Process the event
}

Job progress tracking

Breaking changes

JobProgress.getStats() now returns a JobStats object containing success, inProgress and failed, instead of an APIResponse.

@forge/events 1.x

1
2
const jobId = await queue.push([{ event: 'event1' }, { event: 'event2' }]);
const jobProgress = queue.getJob(jobId);
const response = await jobProgress.getStats();
const { success, inProgress, failed } = await response.json();

@forge/events 2.0.0

1
2
const { jobId } = await queue.push([
    { body: { event: 'event1' } },
    { body: { event: 'event2' } }
]);
const jobProgress = queue.getJob(jobId);
const { success, inProgress, failed } = await jobProgress.getStats();

Job cancellation

Breaking changes

JobProgress.cancel() no longer returns an APIResponse.