Unverified Commit 5540b5ce authored by Hong Minhee's avatar Hong Minhee
Browse files

Outbox error handler

parent 8f8058f1

CHANGES.md

+5 −0
Original line number Diff line number Diff line
@@ -34,6 +34,11 @@ To be released. 
 -  `Context.sendActivity()` method now throws `TypeError` instead of silently

    failing when the given `Activity` object lacks the actor property.



 -  Added outbox error handler to `Federation`.



     -  Added `onOutboxError` option to `new Federation()` constructor.

     -  Added `OutboxErrorHandler` type.



[Hono]: https://hono.dev/

[#25]: https://github.com/dahlia/fedify/issues/25

[#27]: https://github.com/dahlia/fedify/issues/27

federation/callback.ts

+13 −0
Original line number Diff line number Diff line
@@ -85,3 +85,16 @@ export type InboxErrorHandler<TContextData> = ( 
  context: RequestContext<TContextData>,

  error: Error,

) => void | Promise<void>;



/**

 * A callback that handles errors during outbox processing.

 *

 * @param error The error that occurred.

 * @param activity The activity that caused the error.  If it is `null`, the

 *                 error occurred during deserializing the activity.

 * @since 0.6.0

 */

export type OutboxErrorHandler = (

  error: Error,

  activity: Activity | null,

) => void | Promise<void>;

federation/middleware.ts

+26 −4
Original line number Diff line number Diff line
@@ -20,6 +20,7 @@ import type { 
  InboxErrorHandler,

  InboxListener,

  NodeInfoDispatcher,

  OutboxErrorHandler,

} from "./callback.ts";

import type {

  Context,
@@ -82,6 +83,17 @@ export interface FederationParameters { 
   */

  treatHttps?: boolean;



  /**

   * A callback that handles errors during outbox processing.  Note that this

   * callback can be called multiple times for the same error, because failed

   * deliveries are retried.

   *

   * If any errors are thrown in this callback, they are ignored.

   *

   * @since 0.6.0

   */

  onOutboxError?: OutboxErrorHandler;



  // TODO: The following option should be removed, and exponential backoff

  // should be used instead:

  backoffSchedule?: Temporal.Duration[];
@@ -129,6 +141,7 @@ export class Federation<TContextData> { 
  #documentLoader: DocumentLoader;

  #authenticatedDocumentLoaderFactory: AuthenticatedDocumentLoaderFactory;

  #treatHttps: boolean;

  #onOutboxError?: OutboxErrorHandler;

  #backoffSchedule: Temporal.Duration[];



  /**
@@ -143,6 +156,7 @@ export class Federation<TContextData> { 
      documentLoader,

      authenticatedDocumentLoaderFactory,

      treatHttps,

      onOutboxError,

      backoffSchedule,

    }: FederationParameters,

  ) {
@@ -167,6 +181,7 @@ export class Federation<TContextData> { 
    this.#authenticatedDocumentLoaderFactory =

      authenticatedDocumentLoaderFactory ??

        getAuthenticatedDocumentLoader;

    this.#onOutboxError = onOutboxError;

    this.#treatHttps = treatHttps ?? false;

    this.#backoffSchedule = backoffSchedule ?? [

      3_000,
@@ -180,17 +195,24 @@ export class Federation<TContextData> { 
  }



  async #listenQueue(message: OutboxMessage): Promise<void> {

    let activity: Activity | null = null;

    try {

      activity = await Activity.fromJsonLd(message.activity, {

        documentLoader: this.#documentLoader,

      });

      await sendActivity({

        keyId: new URL(message.keyId),

        privateKey: await importJwk(message.privateKey, "private"),

        activity: await Activity.fromJsonLd(message.activity, {

          documentLoader: this.#documentLoader,

        }),

        activity,

        inbox: new URL(message.inbox),

        documentLoader: this.#documentLoader,

      });

    } catch (e) {

      try {

        this.#onOutboxError?.(e, activity);

      } catch (_) {

        // Ignore errors in the error handler.

      }

      if (message.trial < this.#backoffSchedule.length) {

        this.#queue?.enqueue({

          ...message,