@backstage/plugin-events-backend 0.3.12 → 0.3.13-next.1

package/dist/service/hub/DatabaseEventBusStore.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DatabaseEventBusStore.cjs.js","sources":["../../../src/service/hub/DatabaseEventBusStore.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { EventParams } from '@backstage/plugin-events-node';\nimport { EventBusStore } from './types';\nimport { Knex } from 'knex';\nimport {\n  BackstageCredentials,\n  BackstageServicePrincipal,\n  DatabaseService,\n  LifecycleService,\n  LoggerService,\n  SchedulerService,\n  resolvePackagePath,\n} from '@backstage/backend-plugin-api';\nimport { ForwardedError, NotFoundError } from '@backstage/errors';\nimport { HumanDuration, durationToMilliseconds } from '@backstage/types';\n\nconst WINDOW_MAX_COUNT_DEFAULT = 10_000;\nconst WINDOW_MIN_AGE_DEFAULT = { minutes: 10 };\nconst WINDOW_MAX_AGE_DEFAULT = { days: 1 };\n\nconst MAX_BATCH_SIZE = 10;\nconst LISTENER_CONNECTION_TIMEOUT_MS = 60_000;\nconst KEEPALIVE_INTERVAL_MS = 60_000;\n\nconst TABLE_EVENTS = 'event_bus_events';\nconst TABLE_SUBSCRIPTIONS = 'event_bus_subscriptions';\nconst TOPIC_PUBLISH = 'event_bus_publish';\n\ntype EventsRow = {\n  id: string;\n  created_by: string;\n  created_at: Date;\n  topic: string;\n  data_json: string;\n  notified_subscribers: string[];\n};\n\ntype SubscriptionsRow = {\n  id: string;\n  created_by: string;\n  created_at: Date;\n  updated_at: Date;\n  read_until: string;\n  topics: string[];\n};\n\nfunction creatorId(\n  credentials: BackstageCredentials<BackstageServicePrincipal>,\n) {\n  return `service=${credentials.principal.subject}`;\n}\n\nconst migrationsDir = resolvePackagePath(\n  '@backstage/plugin-events-backend',\n  'migrations',\n);\n\ninterface InternalDbClient {\n  acquireRawConnection(): Promise<InternalDbConnection>;\n  destroyRawConnection(conn: InternalDbConnection): Promise<void>;\n}\n\ninterface InternalDbConnection {\n  query(sql: string): Promise<void>;\n  end(): Promise<void>;\n  on(\n    event: 'notification',\n    listener: (event: { channel: string; payload: string }) => void,\n  ): void;\n  on(event: 'error', listener: (error: Error) => void): void;\n  on(event: 'end', listener: (error?: Error) => void): void;\n  removeAllListeners(): void;\n}\n\n// This internal class manages a single connection to the database that all listeners share\nclass DatabaseEventBusListener {\n  readonly #client: InternalDbClient;\n  readonly #logger: LoggerService;\n\n  readonly #listeners = new Set<{\n    topics: Set<string>;\n    resolve: (result: { topic: string }) => void;\n    reject: (error: Error) => void;\n  }>();\n\n  #isShuttingDown = false;\n  #connPromise?: Promise<InternalDbConnection>;\n  #connTimeout?: NodeJS.Timeout;\n  #keepaliveInterval?: NodeJS.Timeout;\n\n  constructor(client: InternalDbClient, logger: LoggerService) {\n    this.#client = client;\n    this.#logger = logger.child({ type: 'DatabaseEventBusListener' });\n  }\n\n  async setupListener(\n    topics: Set<string>,\n    signal: AbortSignal,\n  ): Promise<{ waitForUpdate(): Promise<{ topic: string }> }> {\n    if (this.#connTimeout) {\n      clearTimeout(this.#connTimeout);\n      this.#connTimeout = undefined;\n    }\n\n    await this.#ensureConnection();\n\n    const updatePromise = new Promise<{ topic: string }>((resolve, reject) => {\n      const listener = {\n        topics,\n        resolve(result: { topic: string }) {\n          resolve(result);\n          cleanup();\n        },\n        reject(err: Error) {\n          reject(err);\n          cleanup();\n        },\n      };\n      this.#listeners.add(listener);\n\n      const onAbort = () => {\n        this.#listeners.delete(listener);\n        this.#maybeTimeoutConnection();\n        reject(signal.reason);\n        cleanup();\n      };\n\n      function cleanup() {\n        signal.removeEventListener('abort', onAbort);\n      }\n\n      signal.addEventListener('abort', onAbort);\n    });\n\n    // Ignore unhandled rejections\n    updatePromise.catch(() => {});\n\n    return { waitForUpdate: () => updatePromise };\n  }\n\n  async shutdown() {\n    if (this.#isShuttingDown) {\n      return;\n    }\n    this.#isShuttingDown = true;\n    const conn = await this.#connPromise?.catch(() => undefined);\n    if (conn) {\n      this.#destroyConnection(conn);\n    }\n  }\n\n  #handleNotify(topic: string) {\n    this.#logger.debug(`Listener received notification for topic '${topic}'`);\n    for (const l of this.#listeners) {\n      if (l.topics.has(topic)) {\n        l.resolve({ topic });\n        this.#listeners.delete(l);\n      }\n    }\n    this.#maybeTimeoutConnection();\n  }\n\n  // We don't try to reconnect on error, instead we notify all listeners and let\n  // them try to establish a new connection\n  #handleError(error: Error) {\n    this.#logger.error(\n      `Listener connection failed, notifying all listeners`,\n      error,\n    );\n    for (const l of this.#listeners) {\n      l.reject(new Error('Listener connection failed'));\n    }\n    this.#listeners.clear();\n    this.#maybeTimeoutConnection();\n  }\n\n  #maybeTimeoutConnection() {\n    // If we don't have any listeners, destroy the connection after a timeout\n    if (this.#listeners.size === 0 && !this.#connTimeout) {\n      this.#connTimeout = setTimeout(() => {\n        this.#connTimeout = undefined;\n        this.#connPromise?.then(conn => {\n          this.#logger.info('Listener connection timed out, destroying');\n          this.#connPromise = undefined;\n          this.#destroyConnection(conn);\n        });\n      }, LISTENER_CONNECTION_TIMEOUT_MS);\n    }\n  }\n\n  #destroyConnection(conn: InternalDbConnection) {\n    if (this.#keepaliveInterval) {\n      clearInterval(this.#keepaliveInterval);\n      this.#keepaliveInterval = undefined;\n    }\n    this.#client.destroyRawConnection(conn).catch(error => {\n      this.#logger.error(`Listener failed to destroy connection`, error);\n    });\n    conn.removeAllListeners();\n  }\n\n  async #ensureConnection() {\n    if (this.#isShuttingDown) {\n      throw new Error('Listener is shutting down');\n    }\n    if (this.#connPromise) {\n      await this.#connPromise;\n      return;\n    }\n    this.#connPromise = Promise.resolve().then(async () => {\n      const conn = await this.#client.acquireRawConnection();\n\n      try {\n        await conn.query(`LISTEN ${TOPIC_PUBLISH}`);\n\n        // Set up a keepalive interval to make sure the connection stays alive\n        if (this.#keepaliveInterval) {\n          clearInterval(this.#keepaliveInterval);\n        }\n        this.#keepaliveInterval = setInterval(() => {\n          conn.query('select 1').catch(error => {\n            this.#connPromise = undefined;\n            this.#destroyConnection(conn);\n            this.#handleError(new ForwardedError('Keepalive failed', error));\n          });\n        }, KEEPALIVE_INTERVAL_MS);\n\n        conn.on('notification', event => {\n          this.#handleNotify(event.payload);\n        });\n        conn.on('error', error => {\n          this.#connPromise = undefined;\n          this.#destroyConnection(conn);\n          this.#handleError(error);\n        });\n        conn.on('end', error => {\n          this.#connPromise = undefined;\n          this.#destroyConnection(conn);\n          this.#handleError(\n            error ?? new Error('Connection ended unexpectedly'),\n          );\n        });\n        return conn;\n      } catch (error) {\n        this.#destroyConnection(conn);\n        throw error;\n      }\n    });\n    try {\n      await this.#connPromise;\n    } catch (error) {\n      this.#connPromise = undefined;\n      throw error;\n    }\n  }\n}\n\nexport class DatabaseEventBusStore implements EventBusStore {\n  static async create(options: {\n    database: DatabaseService;\n    logger: LoggerService;\n    scheduler: SchedulerService;\n    lifecycle: LifecycleService;\n    window?: {\n      /** Events within this range will never be deleted */\n      minAge?: HumanDuration;\n      /** Events outside of this age will always be deleted */\n      maxAge?: HumanDuration;\n      /** Events outside of this count will be deleted if they are outside the minAge window */\n      maxCount?: number;\n    };\n  }): Promise<DatabaseEventBusStore> {\n    const db = await options.database.getClient();\n\n    if (db.client.config.client !== 'pg') {\n      throw new Error(\n        `DatabaseEventBusStore only supports PostgreSQL, got '${db.client.config.client}'`,\n      );\n    }\n\n    if (!options.database.migrations?.skip) {\n      await db.migrate.latest({\n        directory: migrationsDir,\n      });\n    }\n\n    const listener = new DatabaseEventBusListener(db.client, options.logger);\n\n    const store = new DatabaseEventBusStore(\n      db,\n      options.logger,\n      listener,\n      options.window?.maxCount ?? WINDOW_MAX_COUNT_DEFAULT,\n      durationToMilliseconds(options.window?.minAge ?? WINDOW_MIN_AGE_DEFAULT),\n      durationToMilliseconds(options.window?.maxAge ?? WINDOW_MAX_AGE_DEFAULT),\n    );\n\n    await options.scheduler.scheduleTask({\n      id: 'event-bus-cleanup',\n      frequency: { seconds: 10 },\n      timeout: { minutes: 1 },\n      initialDelay: { seconds: 10 },\n      fn: () => store.#cleanup(),\n    });\n\n    options.lifecycle.addShutdownHook(async () => {\n      await listener.shutdown();\n    });\n\n    return store;\n  }\n\n  /** @internal */\n  static async forTest({\n    db,\n    logger,\n    minAge = 0,\n    maxAge = 10_000,\n  }: {\n    db: Knex;\n    logger: LoggerService;\n    minAge?: number;\n    maxAge?: number;\n  }) {\n    await db.migrate.latest({ directory: migrationsDir });\n\n    const store = new DatabaseEventBusStore(\n      db,\n      logger,\n      new DatabaseEventBusListener(db.client, logger),\n      5,\n      minAge,\n      maxAge,\n    );\n\n    return Object.assign(store, { clean: () => store.#cleanup() });\n  }\n\n  readonly #db: Knex;\n  readonly #logger: LoggerService;\n  readonly #listener: DatabaseEventBusListener;\n  readonly #windowMaxCount: number;\n  readonly #windowMinAge: number;\n  readonly #windowMaxAge: number;\n\n  private constructor(\n    db: Knex,\n    logger: LoggerService,\n    listener: DatabaseEventBusListener,\n    windowMaxCount: number,\n    windowMinAge: number,\n    windowMaxAge: number,\n  ) {\n    this.#db = db;\n    this.#logger = logger;\n    this.#listener = listener;\n    this.#windowMaxCount = windowMaxCount;\n    this.#windowMinAge = windowMinAge;\n    this.#windowMaxAge = windowMaxAge;\n  }\n\n  async publish(options: {\n    event: EventParams;\n    notifiedSubscribers?: string[];\n    credentials: BackstageCredentials<BackstageServicePrincipal>;\n  }): Promise<{ eventId: string } | undefined> {\n    const topic = options.event.topic;\n    const notifiedSubscribers = options.notifiedSubscribers ?? [];\n    // This query inserts a new event into the database, but only if there are\n    // subscribers to the topic that have not already been notified\n    const result = await this.#db\n      // There's no clean way to create a INSERT INTO .. SELECT with knex, so we end up with quite a lot of .raw(...)\n      .into(\n        this.#db.raw('?? (??, ??, ??, ??)', [\n          TABLE_EVENTS,\n          // These are the rows that we insert, and should match the SELECT below\n          'created_by',\n          'topic',\n          'data_json',\n          'notified_subscribers',\n        ]),\n      )\n      .insert<EventsRow>(\n        (q: Knex.QueryBuilder) =>\n          q\n            // We're not reading data to insert from anywhere else, just raw data\n            .select(\n              this.#db.raw('?', [creatorId(options.credentials)]),\n              this.#db.raw('?', [topic]),\n              this.#db.raw('?', [\n                JSON.stringify({\n                  payload: options.event.eventPayload,\n                  metadata: options.event.metadata,\n                }),\n              ]),\n              this.#db.raw('?', [notifiedSubscribers]),\n            )\n            // The rest of this query is to check whether there are any\n            // subscribers that have not been notified yet\n            .from(TABLE_SUBSCRIPTIONS)\n            .whereNotIn('id', notifiedSubscribers) // Skip notified subscribers\n            .andWhere(this.#db.raw('? = ANY(topics)', [topic])) // Match topic\n            .having(this.#db.raw('count(*)'), '>', 0), // Check if there are any results\n      )\n      .returning<{ id: string }[]>('id');\n\n    if (result.length === 0) {\n      return undefined;\n    }\n    if (result.length > 1) {\n      throw new Error(\n        `Failed to insert event, unexpectedly updated ${result.length} rows`,\n      );\n    }\n\n    const [{ id }] = result;\n\n    // Notify other event bus instances that an event is available on the topic\n    const notifyResult = await this.#db.select(\n      this.#db.raw(`pg_notify(?, ?)`, [TOPIC_PUBLISH, topic]),\n    );\n    if (notifyResult?.length !== 1) {\n      this.#logger.warn(\n        `Failed to notify subscribers of event with ID '${id}' on topic '${topic}'`,\n      );\n    }\n\n    return { eventId: id };\n  }\n\n  async upsertSubscription(\n    id: string,\n    topics: string[],\n    credentials: BackstageCredentials<BackstageServicePrincipal>,\n  ): Promise<void> {\n    const [{ max: maxId }] = await this.#db(TABLE_EVENTS).max('id');\n    const result = await this.#db<SubscriptionsRow>(TABLE_SUBSCRIPTIONS)\n      .insert({\n        id,\n        created_by: creatorId(credentials),\n        updated_at: this.#db.fn.now(),\n        topics,\n        read_until: maxId || 0,\n      })\n      .onConflict('id')\n      .merge(['created_by', 'topics', 'updated_at'])\n      .returning('*');\n\n    if (result.length !== 1) {\n      throw new Error(\n        `Failed to upsert subscription, updated ${result.length} rows`,\n      );\n    }\n  }\n\n  async readSubscription(id: string): Promise<{ events: EventParams[] }> {\n    // The below query selects the subscription we're reading from, locks it for\n    // an update, reads events for the subscription up to the limit, and then\n    // updates the pointer to the last read event.\n    //\n    // This is written as a plain SQL query to spare us all the horrors of\n    // expressing this in knex.\n\n    const { rows: result } = await this.#db.raw<{\n      rows: [] | [{ events: EventsRow[] }];\n    }>(\n      `\n      WITH subscription AS (\n        SELECT topics, read_until\n        FROM event_bus_subscriptions\n        WHERE id = :id\n        FOR UPDATE\n      ),\n      selected_events AS (\n        SELECT event_bus_events.*\n        FROM event_bus_events\n        INNER JOIN subscription\n        ON event_bus_events.topic = ANY(subscription.topics)\n        WHERE event_bus_events.id > subscription.read_until\n        AND NOT :id = ANY(event_bus_events.notified_subscribers)\n        ORDER BY event_bus_events.id ASC LIMIT :limit\n      ),\n      last_event_id AS (\n        SELECT max(id) AS last_event_id\n        FROM selected_events\n      ),\n      events_array AS (\n        SELECT json_agg(row_to_json(selected_events)) AS events\n        FROM selected_events\n      )\n      UPDATE event_bus_subscriptions\n      SET read_until = COALESCE(last_event_id, (SELECT MAX(id) FROM event_bus_events), 0)\n      FROM events_array, last_event_id\n      WHERE event_bus_subscriptions.id = :id\n      RETURNING events_array.events\n    `,\n      { id, limit: MAX_BATCH_SIZE },\n    );\n\n    if (result.length === 0) {\n      throw new NotFoundError(`Subscription with ID '${id}' not found`);\n    } else if (result.length > 1) {\n      throw new Error(\n        `Failed to read subscription, unexpectedly updated ${result.length} rows`,\n      );\n    }\n\n    const rows = result[0].events;\n    if (!rows || rows.length === 0) {\n      return { events: [] };\n    }\n\n    return {\n      events: rows.map(row => {\n        const { payload, metadata } = JSON.parse(row.data_json);\n        return {\n          topic: row.topic,\n          eventPayload: payload,\n          metadata,\n        };\n      }),\n    };\n  }\n\n  async setupListener(\n    subscriptionId: string,\n    options: {\n      signal: AbortSignal;\n    },\n  ): Promise<{ waitForUpdate(): Promise<{ topic: string }> }> {\n    const result = await this.#db<SubscriptionsRow>(TABLE_SUBSCRIPTIONS)\n      .select('topics')\n      .where({ id: subscriptionId })\n      .first();\n\n    if (!result) {\n      throw new NotFoundError(\n        `Subscription with ID '${subscriptionId}' not found`,\n      );\n    }\n\n    options.signal.throwIfAborted();\n\n    return this.#listener.setupListener(\n      new Set(result.topics ?? []),\n      options.signal,\n    );\n  }\n\n  async #cleanup() {\n    try {\n      const eventCount = await this.#db(TABLE_EVENTS)\n        .delete()\n        // Delete any events that are outside both the min age and size window\n        .orWhere(inner =>\n          inner\n            .whereIn(\n              'id',\n              this.#db\n                .select('id')\n                .from(TABLE_EVENTS)\n                .orderBy('id', 'desc')\n                .offset(this.#windowMaxCount),\n            )\n            .andWhere(\n              'created_at',\n              '<',\n              new Date(Date.now() - this.#windowMinAge),\n            ),\n        )\n        // If events are outside the max age they will always be deleted\n        .orWhere('created_at', '<', new Date(Date.now() - this.#windowMaxAge));\n\n      if (eventCount > 0) {\n        this.#logger.info(\n          `Event cleanup resulted in ${eventCount} old events being deleted`,\n        );\n      }\n    } catch (error) {\n      this.#logger.error('Event cleanup failed', error);\n    }\n\n    try {\n      // Delete any subscribers that aren't keeping up with current events\n      const [{ min: minId }] = await this.#db(TABLE_EVENTS).min('id');\n\n      let subscriberCount;\n      if (minId === null) {\n        // No events left, remove all subscribers. This can happen if no events\n        // are published within the max age window.\n        subscriberCount = await this.#db(TABLE_SUBSCRIPTIONS).delete();\n      } else {\n        subscriberCount = await this.#db(TABLE_SUBSCRIPTIONS)\n          .delete()\n          // Read pointer points to the ID that has been read, so we need an additional offset\n          .where('read_until', '<', minId - 1);\n      }\n\n      if (subscriberCount > 0) {\n        this.#logger.info(\n          `Subscription cleanup resulted in ${subscriberCount} stale subscribers being deleted`,\n        );\n      }\n    } catch (error) {\n      this.#logger.error('Subscription cleanup failed', error);\n    }\n  }\n}\n"],"names":["resolvePackagePath","ForwardedError","durationToMilliseconds","NotFoundError"],"mappings":";;;;;;AA8BA,MAAM,wBAA2B,GAAA,GAAA,CAAA;AACjC,MAAM,sBAAA,GAAyB,EAAE,OAAA,EAAS,EAAG,EAAA,CAAA;AAC7C,MAAM,sBAAA,GAAyB,EAAE,IAAA,EAAM,CAAE,EAAA,CAAA;AAEzC,MAAM,cAAiB,GAAA,EAAA,CAAA;AACvB,MAAM,8BAAiC,GAAA,GAAA,CAAA;AACvC,MAAM,qBAAwB,GAAA,GAAA,CAAA;AAE9B,MAAM,YAAe,GAAA,kBAAA,CAAA;AACrB,MAAM,mBAAsB,GAAA,yBAAA,CAAA;AAC5B,MAAM,aAAgB,GAAA,mBAAA,CAAA;AAoBtB,SAAS,UACP,WACA,EAAA;AACA,EAAO,OAAA,CAAA,QAAA,EAAW,WAAY,CAAA,SAAA,CAAU,OAAO,CAAA,CAAA,CAAA;AACjD,CAAA;AAEA,MAAM,aAAgB,GAAAA,mCAAA;AAAA,EACpB,kCAAA;AAAA,EACA,YAAA;AACF,CAAA,CAAA;AAoBA,MAAM,wBAAyB,CAAA;AAAA,EACpB,OAAA,CAAA;AAAA,EACA,OAAA,CAAA;AAAA,EAEA,UAAA,uBAAiB,GAIvB,EAAA,CAAA;AAAA,EAEH,eAAkB,GAAA,KAAA,CAAA;AAAA,EAClB,YAAA,CAAA;AAAA,EACA,YAAA,CAAA;AAAA,EACA,kBAAA,CAAA;AAAA,EAEA,WAAA,CAAY,QAA0B,MAAuB,EAAA;AAC3D,IAAA,IAAA,CAAK,OAAU,GAAA,MAAA,CAAA;AACf,IAAA,IAAA,CAAK,UAAU,MAAO,CAAA,KAAA,CAAM,EAAE,IAAA,EAAM,4BAA4B,CAAA,CAAA;AAAA,GAClE;AAAA,EAEA,MAAM,aACJ,CAAA,MAAA,EACA,MAC0D,EAAA;AAC1D,IAAA,IAAI,KAAK,YAAc,EAAA;AACrB,MAAA,YAAA,CAAa,KAAK,YAAY,CAAA,CAAA;AAC9B,MAAA,IAAA,CAAK,YAAe,GAAA,KAAA,CAAA,CAAA;AAAA,KACtB;AAEA,IAAA,MAAM,KAAK,iBAAkB,EAAA,CAAA;AAE7B,IAAA,MAAM,aAAgB,GAAA,IAAI,OAA2B,CAAA,CAAC,SAAS,MAAW,KAAA;AACxE,MAAA,MAAM,QAAW,GAAA;AAAA,QACf,MAAA;AAAA,QACA,QAAQ,MAA2B,EAAA;AACjC,UAAA,OAAA,CAAQ,MAAM,CAAA,CAAA;AACd,UAAQ,OAAA,EAAA,CAAA;AAAA,SACV;AAAA,QACA,OAAO,GAAY,EAAA;AACjB,UAAA,MAAA,CAAO,GAAG,CAAA,CAAA;AACV,UAAQ,OAAA,EAAA,CAAA;AAAA,SACV;AAAA,OACF,CAAA;AACA,MAAK,IAAA,CAAA,UAAA,CAAW,IAAI,QAAQ,CAAA,CAAA;AAE5B,MAAA,MAAM,UAAU,MAAM;AACpB,QAAK,IAAA,CAAA,UAAA,CAAW,OAAO,QAAQ,CAAA,CAAA;AAC/B,QAAA,IAAA,CAAK,uBAAwB,EAAA,CAAA;AAC7B,QAAA,MAAA,CAAO,OAAO,MAAM,CAAA,CAAA;AACpB,QAAQ,OAAA,EAAA,CAAA;AAAA,OACV,CAAA;AAEA,MAAA,SAAS,OAAU,GAAA;AACjB,QAAO,MAAA,CAAA,mBAAA,CAAoB,SAAS,OAAO,CAAA,CAAA;AAAA,OAC7C;AAEA,MAAO,MAAA,CAAA,gBAAA,CAAiB,SAAS,OAAO,CAAA,CAAA;AAAA,KACzC,CAAA,CAAA;AAGD,IAAA,aAAA,CAAc,MAAM,MAAM;AAAA,KAAE,CAAA,CAAA;AAE5B,IAAO,OAAA,EAAE,aAAe,EAAA,MAAM,aAAc,EAAA,CAAA;AAAA,GAC9C;AAAA,EAEA,MAAM,QAAW,GAAA;AACf,IAAA,IAAI,KAAK,eAAiB,EAAA;AACxB,MAAA,OAAA;AAAA,KACF;AACA,IAAA,IAAA,CAAK,eAAkB,GAAA,IAAA,CAAA;AACvB,IAAA,MAAM,OAAO,MAAM,IAAA,CAAK,YAAc,EAAA,KAAA,CAAM,MAAM,KAAS,CAAA,CAAA,CAAA;AAC3D,IAAA,IAAI,IAAM,EAAA;AACR,MAAA,IAAA,CAAK,mBAAmB,IAAI,CAAA,CAAA;AAAA,KAC9B;AAAA,GACF;AAAA,EAEA,cAAc,KAAe,EAAA;AAC3B,IAAA,IAAA,CAAK,OAAQ,CAAA,KAAA,CAAM,CAA6C,0CAAA,EAAA,KAAK,CAAG,CAAA,CAAA,CAAA,CAAA;AACxE,IAAW,KAAA,MAAA,CAAA,IAAK,KAAK,UAAY,EAAA;AAC/B,MAAA,IAAI,CAAE,CAAA,MAAA,CAAO,GAAI,CAAA,KAAK,CAAG,EAAA;AACvB,QAAE,CAAA,CAAA,OAAA,CAAQ,EAAE,KAAA,EAAO,CAAA,CAAA;AACnB,QAAK,IAAA,CAAA,UAAA,CAAW,OAAO,CAAC,CAAA,CAAA;AAAA,OAC1B;AAAA,KACF;AACA,IAAA,IAAA,CAAK,uBAAwB,EAAA,CAAA;AAAA,GAC/B;AAAA;AAAA;AAAA,EAIA,aAAa,KAAc,EAAA;AACzB,IAAA,IAAA,CAAK,OAAQ,CAAA,KAAA;AAAA,MACX,CAAA,mDAAA,CAAA;AAAA,MACA,KAAA;AAAA,KACF,CAAA;AACA,IAAW,KAAA,MAAA,CAAA,IAAK,KAAK,UAAY,EAAA;AAC/B,MAAA,CAAA,CAAE,MAAO,CAAA,IAAI,KAAM,CAAA,4BAA4B,CAAC,CAAA,CAAA;AAAA,KAClD;AACA,IAAA,IAAA,CAAK,WAAW,KAAM,EAAA,CAAA;AACtB,IAAA,IAAA,CAAK,uBAAwB,EAAA,CAAA;AAAA,GAC/B;AAAA,EAEA,uBAA0B,GAAA;AAExB,IAAA,IAAI,KAAK,UAAW,CAAA,IAAA,KAAS,CAAK,IAAA,CAAC,KAAK,YAAc,EAAA;AACpD,MAAK,IAAA,CAAA,YAAA,GAAe,WAAW,MAAM;AACnC,QAAA,IAAA,CAAK,YAAe,GAAA,KAAA,CAAA,CAAA;AACpB,QAAK,IAAA,CAAA,YAAA,EAAc,KAAK,CAAQ,IAAA,KAAA;AAC9B,UAAK,IAAA,CAAA,OAAA,CAAQ,KAAK,2CAA2C,CAAA,CAAA;AAC7D,UAAA,IAAA,CAAK,YAAe,GAAA,KAAA,CAAA,CAAA;AACpB,UAAA,IAAA,CAAK,mBAAmB,IAAI,CAAA,CAAA;AAAA,SAC7B,CAAA,CAAA;AAAA,SACA,8BAA8B,CAAA,CAAA;AAAA,KACnC;AAAA,GACF;AAAA,EAEA,mBAAmB,IAA4B,EAAA;AAC7C,IAAA,IAAI,KAAK,kBAAoB,EAAA;AAC3B,MAAA,aAAA,CAAc,KAAK,kBAAkB,CAAA,CAAA;AACrC,MAAA,IAAA,CAAK,kBAAqB,GAAA,KAAA,CAAA,CAAA;AAAA,KAC5B;AACA,IAAA,IAAA,CAAK,OAAQ,CAAA,oBAAA,CAAqB,IAAI,CAAA,CAAE,MAAM,CAAS,KAAA,KAAA;AACrD,MAAK,IAAA,CAAA,OAAA,CAAQ,KAAM,CAAA,CAAA,qCAAA,CAAA,EAAyC,KAAK,CAAA,CAAA;AAAA,KAClE,CAAA,CAAA;AACD,IAAA,IAAA,CAAK,kBAAmB,EAAA,CAAA;AAAA,GAC1B;AAAA,EAEA,MAAM,iBAAoB,GAAA;AACxB,IAAA,IAAI,KAAK,eAAiB,EAAA;AACxB,MAAM,MAAA,IAAI,MAAM,2BAA2B,CAAA,CAAA;AAAA,KAC7C;AACA,IAAA,IAAI,KAAK,YAAc,EAAA;AACrB,MAAA,MAAM,IAAK,CAAA,YAAA,CAAA;AACX,MAAA,OAAA;AAAA,KACF;AACA,IAAA,IAAA,CAAK,YAAe,GAAA,OAAA,CAAQ,OAAQ,EAAA,CAAE,KAAK,YAAY;AACrD,MAAA,MAAM,IAAO,GAAA,MAAM,IAAK,CAAA,OAAA,CAAQ,oBAAqB,EAAA,CAAA;AAErD,MAAI,IAAA;AACF,QAAA,MAAM,IAAK,CAAA,KAAA,CAAM,CAAU,OAAA,EAAA,aAAa,CAAE,CAAA,CAAA,CAAA;AAG1C,QAAA,IAAI,KAAK,kBAAoB,EAAA;AAC3B,UAAA,aAAA,CAAc,KAAK,kBAAkB,CAAA,CAAA;AAAA,SACvC;AACA,QAAK,IAAA,CAAA,kBAAA,GAAqB,YAAY,MAAM;AAC1C,UAAA,IAAA,CAAK,KAAM,CAAA,UAAU,CAAE,CAAA,KAAA,CAAM,CAAS,KAAA,KAAA;AACpC,YAAA,IAAA,CAAK,YAAe,GAAA,KAAA,CAAA,CAAA;AACpB,YAAA,IAAA,CAAK,mBAAmB,IAAI,CAAA,CAAA;AAC5B,YAAA,IAAA,CAAK,YAAa,CAAA,IAAIC,qBAAe,CAAA,kBAAA,EAAoB,KAAK,CAAC,CAAA,CAAA;AAAA,WAChE,CAAA,CAAA;AAAA,WACA,qBAAqB,CAAA,CAAA;AAExB,QAAK,IAAA,CAAA,EAAA,CAAG,gBAAgB,CAAS,KAAA,KAAA;AAC/B,UAAK,IAAA,CAAA,aAAA,CAAc,MAAM,OAAO,CAAA,CAAA;AAAA,SACjC,CAAA,CAAA;AACD,QAAK,IAAA,CAAA,EAAA,CAAG,SAAS,CAAS,KAAA,KAAA;AACxB,UAAA,IAAA,CAAK,YAAe,GAAA,KAAA,CAAA,CAAA;AACpB,UAAA,IAAA,CAAK,mBAAmB,IAAI,CAAA,CAAA;AAC5B,UAAA,IAAA,CAAK,aAAa,KAAK,CAAA,CAAA;AAAA,SACxB,CAAA,CAAA;AACD,QAAK,IAAA,CAAA,EAAA,CAAG,OAAO,CAAS,KAAA,KAAA;AACtB,UAAA,IAAA,CAAK,YAAe,GAAA,KAAA,CAAA,CAAA;AACpB,UAAA,IAAA,CAAK,mBAAmB,IAAI,CAAA,CAAA;AAC5B,UAAK,IAAA,CAAA,YAAA;AAAA,YACH,KAAA,IAAS,IAAI,KAAA,CAAM,+BAA+B,CAAA;AAAA,WACpD,CAAA;AAAA,SACD,CAAA,CAAA;AACD,QAAO,OAAA,IAAA,CAAA;AAAA,eACA,KAAO,EAAA;AACd,QAAA,IAAA,CAAK,mBAAmB,IAAI,CAAA,CAAA;AAC5B,QAAM,MAAA,KAAA,CAAA;AAAA,OACR;AAAA,KACD,CAAA,CAAA;AACD,IAAI,IAAA;AACF,MAAA,MAAM,IAAK,CAAA,YAAA,CAAA;AAAA,aACJ,KAAO,EAAA;AACd,MAAA,IAAA,CAAK,YAAe,GAAA,KAAA,CAAA,CAAA;AACpB,MAAM,MAAA,KAAA,CAAA;AAAA,KACR;AAAA,GACF;AACF,CAAA;AAEO,MAAM,qBAA+C,CAAA;AAAA,EAC1D,aAAa,OAAO,OAae,EAAA;AACjC,IAAA,MAAM,EAAK,GAAA,MAAM,OAAQ,CAAA,QAAA,CAAS,SAAU,EAAA,CAAA;AAE5C,IAAA,IAAI,EAAG,CAAA,MAAA,CAAO,MAAO,CAAA,MAAA,KAAW,IAAM,EAAA;AACpC,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAwD,qDAAA,EAAA,EAAA,CAAG,MAAO,CAAA,MAAA,CAAO,MAAM,CAAA,CAAA,CAAA;AAAA,OACjF,CAAA;AAAA,KACF;AAEA,IAAA,IAAI,CAAC,OAAA,CAAQ,QAAS,CAAA,UAAA,EAAY,IAAM,EAAA;AACtC,MAAM,MAAA,EAAA,CAAG,QAAQ,MAAO,CAAA;AAAA,QACtB,SAAW,EAAA,aAAA;AAAA,OACZ,CAAA,CAAA;AAAA,KACH;AAEA,IAAA,MAAM,WAAW,IAAI,wBAAA,CAAyB,EAAG,CAAA,MAAA,EAAQ,QAAQ,MAAM,CAAA,CAAA;AAEvE,IAAA,MAAM,QAAQ,IAAI,qBAAA;AAAA,MAChB,EAAA;AAAA,MACA,OAAQ,CAAA,MAAA;AAAA,MACR,QAAA;AAAA,MACA,OAAA,CAAQ,QAAQ,QAAY,IAAA,wBAAA;AAAA,MAC5BC,4BAAuB,CAAA,OAAA,CAAQ,MAAQ,EAAA,MAAA,IAAU,sBAAsB,CAAA;AAAA,MACvEA,4BAAuB,CAAA,OAAA,CAAQ,MAAQ,EAAA,MAAA,IAAU,sBAAsB,CAAA;AAAA,KACzE,CAAA;AAEA,IAAM,MAAA,OAAA,CAAQ,UAAU,YAAa,CAAA;AAAA,MACnC,EAAI,EAAA,mBAAA;AAAA,MACJ,SAAA,EAAW,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,MACzB,OAAA,EAAS,EAAE,OAAA,EAAS,CAAE,EAAA;AAAA,MACtB,YAAA,EAAc,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,MAC5B,EAAA,EAAI,MAAM,KAAA,CAAM,QAAS,EAAA;AAAA,KAC1B,CAAA,CAAA;AAED,IAAQ,OAAA,CAAA,SAAA,CAAU,gBAAgB,YAAY;AAC5C,MAAA,MAAM,SAAS,QAAS,EAAA,CAAA;AAAA,KACzB,CAAA,CAAA;AAED,IAAO,OAAA,KAAA,CAAA;AAAA,GACT;AAAA;AAAA,EAGA,aAAa,OAAQ,CAAA;AAAA,IACnB,EAAA;AAAA,IACA,MAAA;AAAA,IACA,MAAS,GAAA,CAAA;AAAA,IACT,MAAS,GAAA,GAAA;AAAA,GAMR,EAAA;AACD,IAAA,MAAM,GAAG,OAAQ,CAAA,MAAA,CAAO,EAAE,SAAA,EAAW,eAAe,CAAA,CAAA;AAEpD,IAAA,MAAM,QAAQ,IAAI,qBAAA;AAAA,MAChB,EAAA;AAAA,MACA,MAAA;AAAA,MACA,IAAI,wBAAA,CAAyB,EAAG,CAAA,MAAA,EAAQ,MAAM,CAAA;AAAA,MAC9C,CAAA;AAAA,MACA,MAAA;AAAA,MACA,MAAA;AAAA,KACF,CAAA;AAEA,IAAO,OAAA,MAAA,CAAO,OAAO,KAAO,EAAA,EAAE,OAAO,MAAM,KAAA,CAAM,QAAS,EAAA,EAAG,CAAA,CAAA;AAAA,GAC/D;AAAA,EAES,GAAA,CAAA;AAAA,EACA,OAAA,CAAA;AAAA,EACA,SAAA,CAAA;AAAA,EACA,eAAA,CAAA;AAAA,EACA,aAAA,CAAA;AAAA,EACA,aAAA,CAAA;AAAA,EAED,YACN,EACA,EAAA,MAAA,EACA,QACA,EAAA,cAAA,EACA,cACA,YACA,EAAA;AACA,IAAA,IAAA,CAAK,GAAM,GAAA,EAAA,CAAA;AACX,IAAA,IAAA,CAAK,OAAU,GAAA,MAAA,CAAA;AACf,IAAA,IAAA,CAAK,SAAY,GAAA,QAAA,CAAA;AACjB,IAAA,IAAA,CAAK,eAAkB,GAAA,cAAA,CAAA;AACvB,IAAA,IAAA,CAAK,aAAgB,GAAA,YAAA,CAAA;AACrB,IAAA,IAAA,CAAK,aAAgB,GAAA,YAAA,CAAA;AAAA,GACvB;AAAA,EAEA,MAAM,QAAQ,OAI+B,EAAA;AAC3C,IAAM,MAAA,KAAA,GAAQ,QAAQ,KAAM,CAAA,KAAA,CAAA;AAC5B,IAAM,MAAA,mBAAA,GAAsB,OAAQ,CAAA,mBAAA,IAAuB,EAAC,CAAA;AAG5D,IAAM,MAAA,MAAA,GAAS,MAAM,IAAA,CAAK,GAEvB,CAAA,IAAA;AAAA,MACC,IAAA,CAAK,GAAI,CAAA,GAAA,CAAI,qBAAuB,EAAA;AAAA,QAClC,YAAA;AAAA;AAAA,QAEA,YAAA;AAAA,QACA,OAAA;AAAA,QACA,WAAA;AAAA,QACA,sBAAA;AAAA,OACD,CAAA;AAAA,KAEF,CAAA,MAAA;AAAA,MACC,CAAC,MACC,CAEG,CAAA,MAAA;AAAA,QACC,IAAA,CAAK,IAAI,GAAI,CAAA,GAAA,EAAK,CAAC,SAAU,CAAA,OAAA,CAAQ,WAAW,CAAC,CAAC,CAAA;AAAA,QAClD,KAAK,GAAI,CAAA,GAAA,CAAI,GAAK,EAAA,CAAC,KAAK,CAAC,CAAA;AAAA,QACzB,IAAA,CAAK,GAAI,CAAA,GAAA,CAAI,GAAK,EAAA;AAAA,UAChB,KAAK,SAAU,CAAA;AAAA,YACb,OAAA,EAAS,QAAQ,KAAM,CAAA,YAAA;AAAA,YACvB,QAAA,EAAU,QAAQ,KAAM,CAAA,QAAA;AAAA,WACzB,CAAA;AAAA,SACF,CAAA;AAAA,QACD,KAAK,GAAI,CAAA,GAAA,CAAI,GAAK,EAAA,CAAC,mBAAmB,CAAC,CAAA;AAAA,OACzC,CAGC,IAAK,CAAA,mBAAmB,CACxB,CAAA,UAAA,CAAW,MAAM,mBAAmB,CAAA,CACpC,QAAS,CAAA,IAAA,CAAK,GAAI,CAAA,GAAA,CAAI,mBAAmB,CAAC,KAAK,CAAC,CAAC,CACjD,CAAA,MAAA,CAAO,IAAK,CAAA,GAAA,CAAI,GAAI,CAAA,UAAU,CAAG,EAAA,GAAA,EAAK,CAAC,CAAA;AAAA;AAAA,KAC9C,CACC,UAA4B,IAAI,CAAA,CAAA;AAEnC,IAAI,IAAA,MAAA,CAAO,WAAW,CAAG,EAAA;AACvB,MAAO,OAAA,KAAA,CAAA,CAAA;AAAA,KACT;AACA,IAAI,IAAA,MAAA,CAAO,SAAS,CAAG,EAAA;AACrB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,6CAAA,EAAgD,OAAO,MAAM,CAAA,KAAA,CAAA;AAAA,OAC/D,CAAA;AAAA,KACF;AAEA,IAAA,MAAM,CAAC,EAAE,EAAG,EAAC,CAAI,GAAA,MAAA,CAAA;AAGjB,IAAM,MAAA,YAAA,GAAe,MAAM,IAAA,CAAK,GAAI,CAAA,MAAA;AAAA,MAClC,KAAK,GAAI,CAAA,GAAA,CAAI,mBAAmB,CAAC,aAAA,EAAe,KAAK,CAAC,CAAA;AAAA,KACxD,CAAA;AACA,IAAI,IAAA,YAAA,EAAc,WAAW,CAAG,EAAA;AAC9B,MAAA,IAAA,CAAK,OAAQ,CAAA,IAAA;AAAA,QACX,CAAA,+CAAA,EAAkD,EAAE,CAAA,YAAA,EAAe,KAAK,CAAA,CAAA,CAAA;AAAA,OAC1E,CAAA;AAAA,KACF;AAEA,IAAO,OAAA,EAAE,SAAS,EAAG,EAAA,CAAA;AAAA,GACvB;AAAA,EAEA,MAAM,kBAAA,CACJ,EACA,EAAA,MAAA,EACA,WACe,EAAA;AACf,IAAA,MAAM,CAAC,EAAE,GAAK,EAAA,KAAA,EAAO,CAAA,GAAI,MAAM,IAAA,CAAK,GAAI,CAAA,YAAY,CAAE,CAAA,GAAA,CAAI,IAAI,CAAA,CAAA;AAC9D,IAAA,MAAM,SAAS,MAAM,IAAA,CAAK,GAAsB,CAAA,mBAAmB,EAChE,MAAO,CAAA;AAAA,MACN,EAAA;AAAA,MACA,UAAA,EAAY,UAAU,WAAW,CAAA;AAAA,MACjC,UAAY,EAAA,IAAA,CAAK,GAAI,CAAA,EAAA,CAAG,GAAI,EAAA;AAAA,MAC5B,MAAA;AAAA,MACA,YAAY,KAAS,IAAA,CAAA;AAAA,KACtB,CAAA,CACA,UAAW,CAAA,IAAI,CACf,CAAA,KAAA,CAAM,CAAC,YAAA,EAAc,QAAU,EAAA,YAAY,CAAC,CAAA,CAC5C,UAAU,GAAG,CAAA,CAAA;AAEhB,IAAI,IAAA,MAAA,CAAO,WAAW,CAAG,EAAA;AACvB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,uCAAA,EAA0C,OAAO,MAAM,CAAA,KAAA,CAAA;AAAA,OACzD,CAAA;AAAA,KACF;AAAA,GACF;AAAA,EAEA,MAAM,iBAAiB,EAAgD,EAAA;AAQrE,IAAA,MAAM,EAAE,IAAM,EAAA,MAAA,EAAW,GAAA,MAAM,KAAK,GAAI,CAAA,GAAA;AAAA,MAGtC,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAAA,CAAA;AAAA,MA8BA,EAAE,EAAI,EAAA,KAAA,EAAO,cAAe,EAAA;AAAA,KAC9B,CAAA;AAEA,IAAI,IAAA,MAAA,CAAO,WAAW,CAAG,EAAA;AACvB,MAAA,MAAM,IAAIC,oBAAA,CAAc,CAAyB,sBAAA,EAAA,EAAE,CAAa,WAAA,CAAA,CAAA,CAAA;AAAA,KAClE,MAAA,IAAW,MAAO,CAAA,MAAA,GAAS,CAAG,EAAA;AAC5B,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,kDAAA,EAAqD,OAAO,MAAM,CAAA,KAAA,CAAA;AAAA,OACpE,CAAA;AAAA,KACF;AAEA,IAAM,MAAA,IAAA,GAAO,MAAO,CAAA,CAAC,CAAE,CAAA,MAAA,CAAA;AACvB,IAAA,IAAI,CAAC,IAAA,IAAQ,IAAK,CAAA,MAAA,KAAW,CAAG,EAAA;AAC9B,MAAO,OAAA,EAAE,MAAQ,EAAA,EAAG,EAAA,CAAA;AAAA,KACtB;AAEA,IAAO,OAAA;AAAA,MACL,MAAA,EAAQ,IAAK,CAAA,GAAA,CAAI,CAAO,GAAA,KAAA;AACtB,QAAA,MAAM,EAAE,OAAS,EAAA,QAAA,KAAa,IAAK,CAAA,KAAA,CAAM,IAAI,SAAS,CAAA,CAAA;AACtD,QAAO,OAAA;AAAA,UACL,OAAO,GAAI,CAAA,KAAA;AAAA,UACX,YAAc,EAAA,OAAA;AAAA,UACd,QAAA;AAAA,SACF,CAAA;AAAA,OACD,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,aACJ,CAAA,cAAA,EACA,OAG0D,EAAA;AAC1D,IAAA,MAAM,MAAS,GAAA,MAAM,IAAK,CAAA,GAAA,CAAsB,mBAAmB,CAChE,CAAA,MAAA,CAAO,QAAQ,CAAA,CACf,MAAM,EAAE,EAAA,EAAI,cAAe,EAAC,EAC5B,KAAM,EAAA,CAAA;AAET,IAAA,IAAI,CAAC,MAAQ,EAAA;AACX,MAAA,MAAM,IAAIA,oBAAA;AAAA,QACR,yBAAyB,cAAc,CAAA,WAAA,CAAA;AAAA,OACzC,CAAA;AAAA,KACF;AAEA,IAAA,OAAA,CAAQ,OAAO,cAAe,EAAA,CAAA;AAE9B,IAAA,OAAO,KAAK,SAAU,CAAA,aAAA;AAAA,MACpB,IAAI,GAAA,CAAI,MAAO,CAAA,MAAA,IAAU,EAAE,CAAA;AAAA,MAC3B,OAAQ,CAAA,MAAA;AAAA,KACV,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,QAAW,GAAA;AACf,IAAI,IAAA;AACF,MAAA,MAAM,aAAa,MAAM,IAAA,CAAK,IAAI,YAAY,CAAA,CAC3C,QAEA,CAAA,OAAA;AAAA,QAAQ,WACP,KACG,CAAA,OAAA;AAAA,UACC,IAAA;AAAA,UACA,IAAK,CAAA,GAAA,CACF,MAAO,CAAA,IAAI,EACX,IAAK,CAAA,YAAY,CACjB,CAAA,OAAA,CAAQ,IAAM,EAAA,MAAM,CACpB,CAAA,MAAA,CAAO,KAAK,eAAe,CAAA;AAAA,SAE/B,CAAA,QAAA;AAAA,UACC,YAAA;AAAA,UACA,GAAA;AAAA,UACA,IAAI,IAAK,CAAA,IAAA,CAAK,GAAI,EAAA,GAAI,KAAK,aAAa,CAAA;AAAA,SAC1C;AAAA,OACJ,CAEC,OAAQ,CAAA,YAAA,EAAc,GAAK,EAAA,IAAI,IAAK,CAAA,IAAA,CAAK,GAAI,EAAA,GAAI,IAAK,CAAA,aAAa,CAAC,CAAA,CAAA;AAEvE,MAAA,IAAI,aAAa,CAAG,EAAA;AAClB,QAAA,IAAA,CAAK,OAAQ,CAAA,IAAA;AAAA,UACX,6BAA6B,UAAU,CAAA,yBAAA,CAAA;AAAA,SACzC,CAAA;AAAA,OACF;AAAA,aACO,KAAO,EAAA;AACd,MAAK,IAAA,CAAA,OAAA,CAAQ,KAAM,CAAA,sBAAA,EAAwB,KAAK,CAAA,CAAA;AAAA,KAClD;AAEA,IAAI,IAAA;AAEF,MAAA,MAAM,CAAC,EAAE,GAAK,EAAA,KAAA,EAAO,CAAA,GAAI,MAAM,IAAA,CAAK,GAAI,CAAA,YAAY,CAAE,CAAA,GAAA,CAAI,IAAI,CAAA,CAAA;AAE9D,MAAI,IAAA,eAAA,CAAA;AACJ,MAAA,IAAI,UAAU,IAAM,EAAA;AAGlB,QAAA,eAAA,GAAkB,MAAM,IAAA,CAAK,GAAI,CAAA,mBAAmB,EAAE,MAAO,EAAA,CAAA;AAAA,OACxD,MAAA;AACL,QAAkB,eAAA,GAAA,MAAM,IAAK,CAAA,GAAA,CAAI,mBAAmB,CAAA,CACjD,MAAO,EAAA,CAEP,KAAM,CAAA,YAAA,EAAc,GAAK,EAAA,KAAA,GAAQ,CAAC,CAAA,CAAA;AAAA,OACvC;AAEA,MAAA,IAAI,kBAAkB,CAAG,EAAA;AACvB,QAAA,IAAA,CAAK,OAAQ,CAAA,IAAA;AAAA,UACX,oCAAoC,eAAe,CAAA,gCAAA,CAAA;AAAA,SACrD,CAAA;AAAA,OACF;AAAA,aACO,KAAO,EAAA;AACd,MAAK,IAAA,CAAA,OAAA,CAAQ,KAAM,CAAA,6BAAA,EAA+B,KAAK,CAAA,CAAA;AAAA,KACzD;AAAA,GACF;AACF;;;;"}

package/dist/service/hub/MemoryEventBusStore.cjs.js

@@ -0,0 +1,106 @@
+'use strict';
+
+var errors = require('@backstage/errors');
+
+const MAX_BATCH_SIZE = 10;
+const MAX_EVENTS_DEFAULT = 1e3;
+class MemoryEventBusStore {
+  #maxEvents;
+  #events = new Array();
+  #subscribers = /* @__PURE__ */ new Map();
+  #listeners = /* @__PURE__ */ new Set();
+  constructor(options = {}) {
+    this.#maxEvents = options.maxEvents ?? MAX_EVENTS_DEFAULT;
+  }
+  async publish(options) {
+    const topic = options.event.topic;
+    const notifiedSubscribers = new Set(options.notifiedSubscribers);
+    let hasOtherSubscribers = false;
+    for (const sub of this.#subscribers.values()) {
+      if (sub.topics.has(topic) && !notifiedSubscribers.has(sub.id)) {
+        hasOtherSubscribers = true;
+        break;
+      }
+    }
+    if (!hasOtherSubscribers) {
+      return void 0;
+    }
+    const nextSeq = this.#getMaxSeq() + 1;
+    this.#events.push({ ...options.event, notifiedSubscribers, seq: nextSeq });
+    for (const listener of this.#listeners) {
+      if (listener.topics.has(topic)) {
+        listener.resolve({ topic });
+        this.#listeners.delete(listener);
+      }
+    }
+    if (this.#events.length > this.#maxEvents) {
+      this.#events.shift();
+    }
+    return { eventId: String(nextSeq) };
+  }
+  #getMaxSeq() {
+    return this.#events[this.#events.length - 1]?.seq ?? 0;
+  }
+  async upsertSubscription(id, topics) {
+    const existing = this.#subscribers.get(id);
+    if (existing) {
+      existing.topics = new Set(topics);
+      return;
+    }
+    const sub = {
+      id,
+      seq: this.#getMaxSeq(),
+      topics: new Set(topics)
+    };
+    this.#subscribers.set(id, sub);
+  }
+  async readSubscription(id) {
+    const sub = this.#subscribers.get(id);
+    if (!sub) {
+      throw new errors.NotFoundError(`Subscription not found`);
+    }
+    const events = this.#events.filter(
+      (event) => event.seq > sub.seq && sub.topics.has(event.topic) && !event.notifiedSubscribers.has(id)
+    ).slice(0, MAX_BATCH_SIZE);
+    sub.seq = events[events.length - 1]?.seq ?? sub.seq;
+    return {
+      events: events.map(({ topic, eventPayload }) => ({
+        topic,
+        eventPayload
+      }))
+    };
+  }
+  async setupListener(subscriptionId, options) {
+    return {
+      waitForUpdate: async () => {
+        options.signal.throwIfAborted();
+        const sub = this.#subscribers.get(subscriptionId);
+        if (!sub) {
+          throw new errors.NotFoundError(`Subscription not found`);
+        }
+        return new Promise((resolve, reject) => {
+          const listener = {
+            topics: sub.topics,
+            resolve(result) {
+              resolve(result);
+              cleanup();
+            }
+          };
+          this.#listeners.add(listener);
+          const onAbort = () => {
+            this.#listeners.delete(listener);
+            reject(options.signal.reason);
+            cleanup();
+          };
+          function cleanup() {
+            options.signal.removeEventListener("abort", onAbort);
+          }
+          options.signal.addEventListener("abort", onAbort);
+        });
+      }
+    };
+  }
+}
+
+exports.MemoryEventBusStore = MemoryEventBusStore;
+//# sourceMappingURL=MemoryEventBusStore.cjs.js.map

package/dist/service/hub/MemoryEventBusStore.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemoryEventBusStore.cjs.js","sources":["../../../src/service/hub/MemoryEventBusStore.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { EventParams } from '@backstage/plugin-events-node';\nimport { EventBusStore } from './types';\nimport { NotFoundError } from '@backstage/errors';\nimport {\n  BackstageCredentials,\n  BackstageServicePrincipal,\n} from '@backstage/backend-plugin-api';\n\nconst MAX_BATCH_SIZE = 10;\nconst MAX_EVENTS_DEFAULT = 1_000;\n\nexport class MemoryEventBusStore implements EventBusStore {\n  #maxEvents: number;\n  #events = new Array<\n    EventParams & { seq: number; notifiedSubscribers: Set<string> }\n  >();\n  #subscribers = new Map<\n    string,\n    { id: string; seq: number; topics: Set<string> }\n  >();\n  #listeners = new Set<{\n    topics: Set<string>;\n    resolve(result: { topic: string }): void;\n  }>();\n\n  constructor(options: { maxEvents?: number } = {}) {\n    this.#maxEvents = options.maxEvents ?? MAX_EVENTS_DEFAULT;\n  }\n\n  async publish(options: {\n    event: EventParams;\n    notifiedSubscribers: string[];\n    credentials: BackstageCredentials<BackstageServicePrincipal>;\n  }): Promise<{ eventId: string } | undefined> {\n    const topic = options.event.topic;\n    const notifiedSubscribers = new Set(options.notifiedSubscribers);\n\n    let hasOtherSubscribers = false;\n    for (const sub of this.#subscribers.values()) {\n      if (sub.topics.has(topic) && !notifiedSubscribers.has(sub.id)) {\n        hasOtherSubscribers = true;\n        break;\n      }\n    }\n    if (!hasOtherSubscribers) {\n      return undefined;\n    }\n\n    const nextSeq = this.#getMaxSeq() + 1;\n    this.#events.push({ ...options.event, notifiedSubscribers, seq: nextSeq });\n\n    for (const listener of this.#listeners) {\n      if (listener.topics.has(topic)) {\n        listener.resolve({ topic });\n        this.#listeners.delete(listener);\n      }\n    }\n\n    // Trim old events\n    if (this.#events.length > this.#maxEvents) {\n      this.#events.shift();\n    }\n\n    return { eventId: String(nextSeq) };\n  }\n\n  #getMaxSeq() {\n    return this.#events[this.#events.length - 1]?.seq ?? 0;\n  }\n\n  async upsertSubscription(id: string, topics: string[]): Promise<void> {\n    const existing = this.#subscribers.get(id);\n    if (existing) {\n      existing.topics = new Set(topics);\n      return;\n    }\n    const sub = {\n      id: id,\n      seq: this.#getMaxSeq(),\n      topics: new Set(topics),\n    };\n    this.#subscribers.set(id, sub);\n  }\n\n  async readSubscription(id: string): Promise<{ events: EventParams[] }> {\n    const sub = this.#subscribers.get(id);\n    if (!sub) {\n      throw new NotFoundError(`Subscription not found`);\n    }\n    const events = this.#events\n      .filter(\n        event =>\n          event.seq > sub.seq &&\n          sub.topics.has(event.topic) &&\n          !event.notifiedSubscribers.has(id),\n      )\n      .slice(0, MAX_BATCH_SIZE);\n\n    sub.seq = events[events.length - 1]?.seq ?? sub.seq;\n\n    return {\n      events: events.map(({ topic, eventPayload }) => ({\n        topic,\n        eventPayload,\n      })),\n    };\n  }\n\n  async setupListener(\n    subscriptionId: string,\n    options: {\n      signal: AbortSignal;\n    },\n  ): Promise<{ waitForUpdate(): Promise<{ topic: string }> }> {\n    return {\n      waitForUpdate: async () => {\n        options.signal.throwIfAborted();\n\n        const sub = this.#subscribers.get(subscriptionId);\n        if (!sub) {\n          throw new NotFoundError(`Subscription not found`);\n        }\n\n        return new Promise<{ topic: string }>((resolve, reject) => {\n          const listener = {\n            topics: sub.topics,\n            resolve(result: { topic: string }) {\n              resolve(result);\n              cleanup();\n            },\n          };\n          this.#listeners.add(listener);\n\n          const onAbort = () => {\n            this.#listeners.delete(listener);\n            reject(options.signal.reason);\n            cleanup();\n          };\n\n          function cleanup() {\n            options.signal.removeEventListener('abort', onAbort);\n          }\n\n          options.signal.addEventListener('abort', onAbort);\n        });\n      },\n    };\n  }\n}\n"],"names":["NotFoundError"],"mappings":";;;;AAuBA,MAAM,cAAiB,GAAA,EAAA,CAAA;AACvB,MAAM,kBAAqB,GAAA,GAAA,CAAA;AAEpB,MAAM,mBAA6C,CAAA;AAAA,EACxD,UAAA,CAAA;AAAA,EACA,OAAA,GAAU,IAAI,KAEZ,EAAA,CAAA;AAAA,EACF,YAAA,uBAAmB,GAGjB,EAAA,CAAA;AAAA,EACF,UAAA,uBAAiB,GAGd,EAAA,CAAA;AAAA,EAEH,WAAA,CAAY,OAAkC,GAAA,EAAI,EAAA;AAChD,IAAK,IAAA,CAAA,UAAA,GAAa,QAAQ,SAAa,IAAA,kBAAA,CAAA;AAAA,GACzC;AAAA,EAEA,MAAM,QAAQ,OAI+B,EAAA;AAC3C,IAAM,MAAA,KAAA,GAAQ,QAAQ,KAAM,CAAA,KAAA,CAAA;AAC5B,IAAA,MAAM,mBAAsB,GAAA,IAAI,GAAI,CAAA,OAAA,CAAQ,mBAAmB,CAAA,CAAA;AAE/D,IAAA,IAAI,mBAAsB,GAAA,KAAA,CAAA;AAC1B,IAAA,KAAA,MAAW,GAAO,IAAA,IAAA,CAAK,YAAa,CAAA,MAAA,EAAU,EAAA;AAC5C,MAAI,IAAA,GAAA,CAAI,MAAO,CAAA,GAAA,CAAI,KAAK,CAAA,IAAK,CAAC,mBAAoB,CAAA,GAAA,CAAI,GAAI,CAAA,EAAE,CAAG,EAAA;AAC7D,QAAsB,mBAAA,GAAA,IAAA,CAAA;AACtB,QAAA,MAAA;AAAA,OACF;AAAA,KACF;AACA,IAAA,IAAI,CAAC,mBAAqB,EAAA;AACxB,MAAO,OAAA,KAAA,CAAA,CAAA;AAAA,KACT;AAEA,IAAM,MAAA,OAAA,GAAU,IAAK,CAAA,UAAA,EAAe,GAAA,CAAA,CAAA;AACpC,IAAK,IAAA,CAAA,OAAA,CAAQ,KAAK,EAAE,GAAG,QAAQ,KAAO,EAAA,mBAAA,EAAqB,GAAK,EAAA,OAAA,EAAS,CAAA,CAAA;AAEzE,IAAW,KAAA,MAAA,QAAA,IAAY,KAAK,UAAY,EAAA;AACtC,MAAA,IAAI,QAAS,CAAA,MAAA,CAAO,GAAI,CAAA,KAAK,CAAG,EAAA;AAC9B,QAAS,QAAA,CAAA,OAAA,CAAQ,EAAE,KAAA,EAAO,CAAA,CAAA;AAC1B,QAAK,IAAA,CAAA,UAAA,CAAW,OAAO,QAAQ,CAAA,CAAA;AAAA,OACjC;AAAA,KACF;AAGA,IAAA,IAAI,IAAK,CAAA,OAAA,CAAQ,MAAS,GAAA,IAAA,CAAK,UAAY,EAAA;AACzC,MAAA,IAAA,CAAK,QAAQ,KAAM,EAAA,CAAA;AAAA,KACrB;AAEA,IAAA,OAAO,EAAE,OAAA,EAAS,MAAO,CAAA,OAAO,CAAE,EAAA,CAAA;AAAA,GACpC;AAAA,EAEA,UAAa,GAAA;AACX,IAAA,OAAO,KAAK,OAAQ,CAAA,IAAA,CAAK,QAAQ,MAAS,GAAA,CAAC,GAAG,GAAO,IAAA,CAAA,CAAA;AAAA,GACvD;AAAA,EAEA,MAAM,kBAAmB,CAAA,EAAA,EAAY,MAAiC,EAAA;AACpE,IAAA,MAAM,QAAW,GAAA,IAAA,CAAK,YAAa,CAAA,GAAA,CAAI,EAAE,CAAA,CAAA;AACzC,IAAA,IAAI,QAAU,EAAA;AACZ,MAAS,QAAA,CAAA,MAAA,GAAS,IAAI,GAAA,CAAI,MAAM,CAAA,CAAA;AAChC,MAAA,OAAA;AAAA,KACF;AACA,IAAA,MAAM,GAAM,GAAA;AAAA,MACV,EAAA;AAAA,MACA,GAAA,EAAK,KAAK,UAAW,EAAA;AAAA,MACrB,MAAA,EAAQ,IAAI,GAAA,CAAI,MAAM,CAAA;AAAA,KACxB,CAAA;AACA,IAAK,IAAA,CAAA,YAAA,CAAa,GAAI,CAAA,EAAA,EAAI,GAAG,CAAA,CAAA;AAAA,GAC/B;AAAA,EAEA,MAAM,iBAAiB,EAAgD,EAAA;AACrE,IAAA,MAAM,GAAM,GAAA,IAAA,CAAK,YAAa,CAAA,GAAA,CAAI,EAAE,CAAA,CAAA;AACpC,IAAA,IAAI,CAAC,GAAK,EAAA;AACR,MAAM,MAAA,IAAIA,qBAAc,CAAwB,sBAAA,CAAA,CAAA,CAAA;AAAA,KAClD;AACA,IAAM,MAAA,MAAA,GAAS,KAAK,OACjB,CAAA,MAAA;AAAA,MACC,CACE,KAAA,KAAA,KAAA,CAAM,GAAM,GAAA,GAAA,CAAI,OAChB,GAAI,CAAA,MAAA,CAAO,GAAI,CAAA,KAAA,CAAM,KAAK,CAC1B,IAAA,CAAC,KAAM,CAAA,mBAAA,CAAoB,IAAI,EAAE,CAAA;AAAA,KACrC,CACC,KAAM,CAAA,CAAA,EAAG,cAAc,CAAA,CAAA;AAE1B,IAAA,GAAA,CAAI,MAAM,MAAO,CAAA,MAAA,CAAO,SAAS,CAAC,CAAA,EAAG,OAAO,GAAI,CAAA,GAAA,CAAA;AAEhD,IAAO,OAAA;AAAA,MACL,QAAQ,MAAO,CAAA,GAAA,CAAI,CAAC,EAAE,KAAA,EAAO,cAAoB,MAAA;AAAA,QAC/C,KAAA;AAAA,QACA,YAAA;AAAA,OACA,CAAA,CAAA;AAAA,KACJ,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,aACJ,CAAA,cAAA,EACA,OAG0D,EAAA;AAC1D,IAAO,OAAA;AAAA,MACL,eAAe,YAAY;AACzB,QAAA,OAAA,CAAQ,OAAO,cAAe,EAAA,CAAA;AAE9B,QAAA,MAAM,GAAM,GAAA,IAAA,CAAK,YAAa,CAAA,GAAA,CAAI,cAAc,CAAA,CAAA;AAChD,QAAA,IAAI,CAAC,GAAK,EAAA;AACR,UAAM,MAAA,IAAIA,qBAAc,CAAwB,sBAAA,CAAA,CAAA,CAAA;AAAA,SAClD;AAEA,QAAA,OAAO,IAAI,OAAA,CAA2B,CAAC,OAAA,EAAS,MAAW,KAAA;AACzD,UAAA,MAAM,QAAW,GAAA;AAAA,YACf,QAAQ,GAAI,CAAA,MAAA;AAAA,YACZ,QAAQ,MAA2B,EAAA;AACjC,cAAA,OAAA,CAAQ,MAAM,CAAA,CAAA;AACd,cAAQ,OAAA,EAAA,CAAA;AAAA,aACV;AAAA,WACF,CAAA;AACA,UAAK,IAAA,CAAA,UAAA,CAAW,IAAI,QAAQ,CAAA,CAAA;AAE5B,UAAA,MAAM,UAAU,MAAM;AACpB,YAAK,IAAA,CAAA,UAAA,CAAW,OAAO,QAAQ,CAAA,CAAA;AAC/B,YAAO,MAAA,CAAA,OAAA,CAAQ,OAAO,MAAM,CAAA,CAAA;AAC5B,YAAQ,OAAA,EAAA,CAAA;AAAA,WACV,CAAA;AAEA,UAAA,SAAS,OAAU,GAAA;AACjB,YAAQ,OAAA,CAAA,MAAA,CAAO,mBAAoB,CAAA,OAAA,EAAS,OAAO,CAAA,CAAA;AAAA,WACrD;AAEA,UAAQ,OAAA,CAAA,MAAA,CAAO,gBAAiB,CAAA,OAAA,EAAS,OAAO,CAAA,CAAA;AAAA,SACjD,CAAA,CAAA;AAAA,OACH;AAAA,KACF,CAAA;AAAA,GACF;AACF;;;;"}

package/dist/service/hub/createEventBusRouter.cjs.js

@@ -0,0 +1,130 @@
+'use strict';
+
+var openapi_generated = require('../../schema/openapi.generated.cjs.js');
+var MemoryEventBusStore = require('./MemoryEventBusStore.cjs.js');
+var DatabaseEventBusStore = require('./DatabaseEventBusStore.cjs.js');
+
+const DEFAULT_NOTIFY_TIMEOUT_MS = 55e3;
+async function createEventBusStore(deps) {
+  const db = await deps.database.getClient();
+  if (db.client.config.client === "pg") {
+    deps.logger.info("Database is PostgreSQL, using database store");
+    return await DatabaseEventBusStore.DatabaseEventBusStore.create(deps);
+  }
+  deps.logger.info("Database is not PostgreSQL, using memory store");
+  return new MemoryEventBusStore.MemoryEventBusStore();
+}
+async function createEventBusRouter(options) {
+  const { httpAuth, notifyTimeoutMs = DEFAULT_NOTIFY_TIMEOUT_MS } = options;
+  const logger = options.logger.child({ type: "EventBus" });
+  const store = await createEventBusStore(options);
+  const apiRouter = await openapi_generated.createOpenApiRouter();
+  apiRouter.post("/bus/v1/events", async (req, res) => {
+    const credentials = await httpAuth.credentials(req, {
+      allow: ["service"]
+    });
+    const topic = req.body.event.topic;
+    const notifiedSubscribers = req.body.notifiedSubscribers;
+    const result = await store.publish({
+      event: {
+        topic,
+        eventPayload: req.body.event.payload
+      },
+      notifiedSubscribers,
+      credentials
+    });
+    if (result) {
+      logger.debug(
+        `Published event to '${topic}' with ID '${result.eventId}'`,
+        {
+          subject: credentials.principal.subject
+        }
+      );
+      res.status(201).end();
+    } else {
+      if (notifiedSubscribers) {
+        const notified = `'${notifiedSubscribers.join("', '")}'`;
+        logger.debug(
+          `Skipped publishing of event to '${topic}', subscribers have already been notified: ${notified}`,
+          { subject: credentials.principal.subject }
+        );
+      } else {
+        logger.debug(
+          `Skipped publishing of event to '${topic}', no subscribers present`,
+          { subject: credentials.principal.subject }
+        );
+      }
+      res.status(204).end();
+    }
+  });
+  apiRouter.get(
+    "/bus/v1/subscriptions/:subscriptionId/events",
+    async (req, res) => {
+      const credentials = await httpAuth.credentials(req, {
+        allow: ["service"]
+      });
+      const id = req.params.subscriptionId;
+      const controller = new AbortController();
+      req.on("end", () => controller.abort());
+      const listener = await store.setupListener(id, {
+        signal: controller.signal
+      });
+      const timeout = setTimeout(() => {
+        controller.abort();
+      }, notifyTimeoutMs);
+      try {
+        const { events } = await store.readSubscription(id);
+        logger.debug(
+          `Reading subscription '${id}' resulted in ${events.length} events`,
+          { subject: credentials.principal.subject }
+        );
+        if (events.length > 0) {
+          res.json({
+            events: events.map((event) => ({
+              topic: event.topic,
+              payload: event.eventPayload
+            }))
+          });
+        } else {
+          res.status(202);
+          res.flushHeaders();
+          try {
+            const { topic } = await listener.waitForUpdate();
+            logger.debug(
+              `Received notification for subscription '${id}' for topic '${topic}'`,
+              { subject: credentials.principal.subject }
+            );
+          } catch (error) {
+            if (error !== controller.signal.reason) {
+              logger.error(`Error listening for subscription '${id}'`, error);
+            }
+          } finally {
+            await new Promise(
+              (resolve) => setTimeout(resolve, 1 + Math.random() * 9)
+            );
+            res.end();
+          }
+        }
+      } finally {
+        controller.abort();
+        clearTimeout(timeout);
+      }
+    }
+  );
+  apiRouter.put("/bus/v1/subscriptions/:subscriptionId", async (req, res) => {
+    const credentials = await httpAuth.credentials(req, {
+      allow: ["service"]
+    });
+    const id = req.params.subscriptionId;
+    await store.upsertSubscription(id, req.body.topics, credentials);
+    logger.debug(
+      `New subscription '${id}' for topics '${req.body.topics.join("', '")}'`,
+      { subject: credentials.principal.subject }
+    );
+    res.status(201).end();
+  });
+  return apiRouter;
+}
+
+exports.createEventBusRouter = createEventBusRouter;
+//# sourceMappingURL=createEventBusRouter.cjs.js.map

package/dist/service/hub/createEventBusRouter.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createEventBusRouter.cjs.js","sources":["../../../src/service/hub/createEventBusRouter.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  DatabaseService,\n  HttpAuthService,\n  LifecycleService,\n  LoggerService,\n  SchedulerService,\n} from '@backstage/backend-plugin-api';\nimport { Handler } from 'express';\nimport { createOpenApiRouter } from '../../schema/openapi.generated';\nimport { MemoryEventBusStore } from './MemoryEventBusStore';\nimport { DatabaseEventBusStore } from './DatabaseEventBusStore';\nimport { EventBusStore } from './types';\nimport { EventParams } from '@backstage/plugin-events-node';\n\nconst DEFAULT_NOTIFY_TIMEOUT_MS = 55_000; // Just below 60s, which is a common HTTP timeout\n\n/*\n\n# Event Bus\n\nThis comment describes the event bus that is implemented here in the events\nbackend, and by default used by the events service.\n\n## Overview\n\nThe events bus implements a subscription mechanism where subscribers must exist\nupfront for events to be stored. It uses a single inbox for all events, with\neach subscriber having its own pointer for how far into the inbox it has read.\n\nIn order to avoid busy polling, the API uses a long-polling mechanism where a\nrequest is left hanging until the client should try to read again.\n\nThe event bus is not implemented with any guarantees of events being consumed,\nbut it does aim to make it unlikely that events are dropped\n\n## API\n\n### POST /bus/v1/events\n\nThis endpoint is used to publish new events to the event bus on a specific\ntopic. It can optionally include a set of subscription IDs for subscribers that\nhave already been notified of the event. This is to enable an optimization where\nwe notify subscribers locally if possible, and avoid the need for events to be\nrelayed through the events bus at all of possible.\n\nFor an event to be published and stored there must already exist a subscriber\nthat is subscribed to the event's topic, and that hasn't already been notified\nof the event. If no such subscriber is found, the event will be discarded.\n\n### PUT /bus/v1/subscriptions/:subscriptionId\n\nThis endpoint is used to create or update a subscriptions. Subscriptions are\nshared across the entire bus and divided by subscription ID. Multiple clients\ncan be reading events from the same subscription at the same time, but only one\nof those clients will receive each event. This enables division of work by using\nthe same subscriber ID across multiple instances, as well as broadcasting by\nensuring separate subscribers IDs.\n\n### GET /bus/v1/subscriptions/:subscriptionId/events\n\nThis endpoint is used to read events from a subscription. It will return a batch\nof events for the subscribed topics that have not yet been read by the\nsubscription. If no such events are available, the endpoint will return a 202\nresponse and then hang end response until an event is available or a timeout is\nreached. This allows clients to call this endpoint in a loop but will keep\ntraffic overhead fairly low.\n\n## Delivery guarantees\n\nWhen reading events from the event bus, clients should always implement a\ngraceful shutdown where they process any events that are received from the\nevents endpoint before shutting down. This is also the reason that the events\nendpoint does not return any events when responding with a 202 blocking the\nresponse, because there would otherwise be a race condition where the events\nmight be lost in transit if the client shuts down. By always sending an empty\nresponse and requiring the client to send another request, we ensure that the\nclient is prepared to halt shutdown until the request had been fully processed.\n\n## Local processing optimization\n\nWhen possible, events will be processed locally before sent to the event bus.\nThe client will also inform the bus of which subscriptions have already been\nnotified of the event, so that the bus can completely avoid storing an event if\nit has already been fully consumed by all subscribers.\n\n## Automated cleanup & event window\n\nEvents are deleted once they are outside the guaranteed storage window. By\ndefault the window 10 minutes for all events, and 24 hours for the last 10000\nevents. This ensures that the event log doesn't grow indefinitely, while still\nallowing subscribers with restarts or outages to catch up to past events,\nensuring that events are likely not lost.\n\nSubscriptions are also cleaned up if their read pointer falls outside of the\ncurrent event window. This ensures that stale subscribers don't accumulate and\ncause unnecessary storage of events.\n\n*/\n\nasync function createEventBusStore(deps: {\n  logger: LoggerService;\n  database: DatabaseService;\n  scheduler: SchedulerService;\n  lifecycle: LifecycleService;\n  httpAuth: HttpAuthService;\n}): Promise<EventBusStore> {\n  const db = await deps.database.getClient();\n  if (db.client.config.client === 'pg') {\n    deps.logger.info('Database is PostgreSQL, using database store');\n    return await DatabaseEventBusStore.create(deps);\n  }\n\n  deps.logger.info('Database is not PostgreSQL, using memory store');\n  return new MemoryEventBusStore();\n}\n\n/**\n * Creates a new event bus router\n * @internal\n */\nexport async function createEventBusRouter(options: {\n  logger: LoggerService;\n  database: DatabaseService;\n  scheduler: SchedulerService;\n  lifecycle: LifecycleService;\n  httpAuth: HttpAuthService;\n  notifyTimeoutMs?: number; // for testing\n}): Promise<Handler> {\n  const { httpAuth, notifyTimeoutMs = DEFAULT_NOTIFY_TIMEOUT_MS } = options;\n  const logger = options.logger.child({ type: 'EventBus' });\n\n  const store = await createEventBusStore(options);\n\n  const apiRouter = await createOpenApiRouter();\n\n  apiRouter.post('/bus/v1/events', async (req, res) => {\n    const credentials = await httpAuth.credentials(req, {\n      allow: ['service'],\n    });\n    const topic = req.body.event.topic;\n    const notifiedSubscribers = req.body.notifiedSubscribers;\n    const result = await store.publish({\n      event: {\n        topic,\n        eventPayload: req.body.event.payload,\n      } as EventParams,\n      notifiedSubscribers,\n      credentials,\n    });\n    if (result) {\n      logger.debug(\n        `Published event to '${topic}' with ID '${result.eventId}'`,\n        {\n          subject: credentials.principal.subject,\n        },\n      );\n      res.status(201).end();\n    } else {\n      if (notifiedSubscribers) {\n        const notified = `'${notifiedSubscribers.join(\"', '\")}'`;\n        logger.debug(\n          `Skipped publishing of event to '${topic}', subscribers have already been notified: ${notified}`,\n          { subject: credentials.principal.subject },\n        );\n      } else {\n        logger.debug(\n          `Skipped publishing of event to '${topic}', no subscribers present`,\n          { subject: credentials.principal.subject },\n        );\n      }\n      res.status(204).end();\n    }\n  });\n\n  apiRouter.get(\n    '/bus/v1/subscriptions/:subscriptionId/events',\n    async (req, res) => {\n      const credentials = await httpAuth.credentials(req, {\n        allow: ['service'],\n      });\n      const id = req.params.subscriptionId;\n\n      const controller = new AbortController();\n      req.on('end', () => controller.abort());\n\n      // By setting up the listener first we make sure we don't miss any events\n      // that are published while reading. If an event is published we'll receive\n      // a notification, which we may ignore depending on the outcome of the read\n      const listener = await store.setupListener(id, {\n        signal: controller.signal,\n      });\n\n      // By timing out requests we make sure they don't stall or that events get stuck.\n      // For the caller there's no difference between a timeout and a\n      // notification, either way they should try reading again.\n      const timeout = setTimeout(() => {\n        controller.abort();\n      }, notifyTimeoutMs);\n\n      try {\n        const { events } = await store.readSubscription(id);\n\n        logger.debug(\n          `Reading subscription '${id}' resulted in ${events.length} events`,\n          { subject: credentials.principal.subject },\n        );\n\n        if (events.length > 0) {\n          res.json({\n            events: events.map(event => ({\n              topic: event.topic,\n              payload: event.eventPayload,\n            })),\n          });\n        } else {\n          res.status(202);\n          res.flushHeaders();\n\n          try {\n            const { topic } = await listener.waitForUpdate();\n            logger.debug(\n              `Received notification for subscription '${id}' for topic '${topic}'`,\n              { subject: credentials.principal.subject },\n            );\n          } catch (error) {\n            if (error !== controller.signal.reason) {\n              logger.error(`Error listening for subscription '${id}'`, error);\n            }\n          } finally {\n            // A small extra delay ensures a more even spread of events across\n            // consumers in case some consumers are faster than others\n            await new Promise(resolve =>\n              setTimeout(resolve, 1 + Math.random() * 9),\n            );\n            res.end();\n          }\n        }\n      } finally {\n        controller.abort();\n        clearTimeout(timeout);\n      }\n    },\n  );\n\n  apiRouter.put('/bus/v1/subscriptions/:subscriptionId', async (req, res) => {\n    const credentials = await httpAuth.credentials(req, {\n      allow: ['service'],\n    });\n    const id = req.params.subscriptionId;\n\n    await store.upsertSubscription(id, req.body.topics, credentials);\n\n    logger.debug(\n      `New subscription '${id}' for topics '${req.body.topics.join(\"', '\")}'`,\n      { subject: credentials.principal.subject },\n    );\n\n    res.status(201).end();\n  });\n\n  return apiRouter;\n}\n"],"names":["DatabaseEventBusStore","MemoryEventBusStore","createOpenApiRouter"],"mappings":";;;;;;AA8BA,MAAM,yBAA4B,GAAA,IAAA,CAAA;AAqFlC,eAAe,oBAAoB,IAMR,EAAA;AACzB,EAAA,MAAM,EAAK,GAAA,MAAM,IAAK,CAAA,QAAA,CAAS,SAAU,EAAA,CAAA;AACzC,EAAA,IAAI,EAAG,CAAA,MAAA,CAAO,MAAO,CAAA,MAAA,KAAW,IAAM,EAAA;AACpC,IAAK,IAAA,CAAA,MAAA,CAAO,KAAK,8CAA8C,CAAA,CAAA;AAC/D,IAAO,OAAA,MAAMA,2CAAsB,CAAA,MAAA,CAAO,IAAI,CAAA,CAAA;AAAA,GAChD;AAEA,EAAK,IAAA,CAAA,MAAA,CAAO,KAAK,gDAAgD,CAAA,CAAA;AACjE,EAAA,OAAO,IAAIC,uCAAoB,EAAA,CAAA;AACjC,CAAA;AAMA,eAAsB,qBAAqB,OAOtB,EAAA;AACnB,EAAA,MAAM,EAAE,QAAA,EAAU,eAAkB,GAAA,yBAAA,EAA8B,GAAA,OAAA,CAAA;AAClE,EAAA,MAAM,SAAS,OAAQ,CAAA,MAAA,CAAO,MAAM,EAAE,IAAA,EAAM,YAAY,CAAA,CAAA;AAExD,EAAM,MAAA,KAAA,GAAQ,MAAM,mBAAA,CAAoB,OAAO,CAAA,CAAA;AAE/C,EAAM,MAAA,SAAA,GAAY,MAAMC,qCAAoB,EAAA,CAAA;AAE5C,EAAA,SAAA,CAAU,IAAK,CAAA,gBAAA,EAAkB,OAAO,GAAA,EAAK,GAAQ,KAAA;AACnD,IAAA,MAAM,WAAc,GAAA,MAAM,QAAS,CAAA,WAAA,CAAY,GAAK,EAAA;AAAA,MAClD,KAAA,EAAO,CAAC,SAAS,CAAA;AAAA,KAClB,CAAA,CAAA;AACD,IAAM,MAAA,KAAA,GAAQ,GAAI,CAAA,IAAA,CAAK,KAAM,CAAA,KAAA,CAAA;AAC7B,IAAM,MAAA,mBAAA,GAAsB,IAAI,IAAK,CAAA,mBAAA,CAAA;AACrC,IAAM,MAAA,MAAA,GAAS,MAAM,KAAA,CAAM,OAAQ,CAAA;AAAA,MACjC,KAAO,EAAA;AAAA,QACL,KAAA;AAAA,QACA,YAAA,EAAc,GAAI,CAAA,IAAA,CAAK,KAAM,CAAA,OAAA;AAAA,OAC/B;AAAA,MACA,mBAAA;AAAA,MACA,WAAA;AAAA,KACD,CAAA,CAAA;AACD,IAAA,IAAI,MAAQ,EAAA;AACV,MAAO,MAAA,CAAA,KAAA;AAAA,QACL,CAAuB,oBAAA,EAAA,KAAK,CAAc,WAAA,EAAA,MAAA,CAAO,OAAO,CAAA,CAAA,CAAA;AAAA,QACxD;AAAA,UACE,OAAA,EAAS,YAAY,SAAU,CAAA,OAAA;AAAA,SACjC;AAAA,OACF,CAAA;AACA,MAAI,GAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,GAAI,EAAA,CAAA;AAAA,KACf,MAAA;AACL,MAAA,IAAI,mBAAqB,EAAA;AACvB,QAAA,MAAM,QAAW,GAAA,CAAA,CAAA,EAAI,mBAAoB,CAAA,IAAA,CAAK,MAAM,CAAC,CAAA,CAAA,CAAA,CAAA;AACrD,QAAO,MAAA,CAAA,KAAA;AAAA,UACL,CAAA,gCAAA,EAAmC,KAAK,CAAA,2CAAA,EAA8C,QAAQ,CAAA,CAAA;AAAA,UAC9F,EAAE,OAAA,EAAS,WAAY,CAAA,SAAA,CAAU,OAAQ,EAAA;AAAA,SAC3C,CAAA;AAAA,OACK,MAAA;AACL,QAAO,MAAA,CAAA,KAAA;AAAA,UACL,mCAAmC,KAAK,CAAA,yBAAA,CAAA;AAAA,UACxC,EAAE,OAAA,EAAS,WAAY,CAAA,SAAA,CAAU,OAAQ,EAAA;AAAA,SAC3C,CAAA;AAAA,OACF;AACA,MAAI,GAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,GAAI,EAAA,CAAA;AAAA,KACtB;AAAA,GACD,CAAA,CAAA;AAED,EAAU,SAAA,CAAA,GAAA;AAAA,IACR,8CAAA;AAAA,IACA,OAAO,KAAK,GAAQ,KAAA;AAClB,MAAA,MAAM,WAAc,GAAA,MAAM,QAAS,CAAA,WAAA,CAAY,GAAK,EAAA;AAAA,QAClD,KAAA,EAAO,CAAC,SAAS,CAAA;AAAA,OAClB,CAAA,CAAA;AACD,MAAM,MAAA,EAAA,GAAK,IAAI,MAAO,CAAA,cAAA,CAAA;AAEtB,MAAM,MAAA,UAAA,GAAa,IAAI,eAAgB,EAAA,CAAA;AACvC,MAAA,GAAA,CAAI,EAAG,CAAA,KAAA,EAAO,MAAM,UAAA,CAAW,OAAO,CAAA,CAAA;AAKtC,MAAA,MAAM,QAAW,GAAA,MAAM,KAAM,CAAA,aAAA,CAAc,EAAI,EAAA;AAAA,QAC7C,QAAQ,UAAW,CAAA,MAAA;AAAA,OACpB,CAAA,CAAA;AAKD,MAAM,MAAA,OAAA,GAAU,WAAW,MAAM;AAC/B,QAAA,UAAA,CAAW,KAAM,EAAA,CAAA;AAAA,SAChB,eAAe,CAAA,CAAA;AAElB,MAAI,IAAA;AACF,QAAA,MAAM,EAAE,MAAO,EAAA,GAAI,MAAM,KAAA,CAAM,iBAAiB,EAAE,CAAA,CAAA;AAElD,QAAO,MAAA,CAAA,KAAA;AAAA,UACL,CAAyB,sBAAA,EAAA,EAAE,CAAiB,cAAA,EAAA,MAAA,CAAO,MAAM,CAAA,OAAA,CAAA;AAAA,UACzD,EAAE,OAAA,EAAS,WAAY,CAAA,SAAA,CAAU,OAAQ,EAAA;AAAA,SAC3C,CAAA;AAEA,QAAI,IAAA,MAAA,CAAO,SAAS,CAAG,EAAA;AACrB,UAAA,GAAA,CAAI,IAAK,CAAA;AAAA,YACP,MAAA,EAAQ,MAAO,CAAA,GAAA,CAAI,CAAU,KAAA,MAAA;AAAA,cAC3B,OAAO,KAAM,CAAA,KAAA;AAAA,cACb,SAAS,KAAM,CAAA,YAAA;AAAA,aACf,CAAA,CAAA;AAAA,WACH,CAAA,CAAA;AAAA,SACI,MAAA;AACL,UAAA,GAAA,CAAI,OAAO,GAAG,CAAA,CAAA;AACd,UAAA,GAAA,CAAI,YAAa,EAAA,CAAA;AAEjB,UAAI,IAAA;AACF,YAAA,MAAM,EAAE,KAAA,EAAU,GAAA,MAAM,SAAS,aAAc,EAAA,CAAA;AAC/C,YAAO,MAAA,CAAA,KAAA;AAAA,cACL,CAAA,wCAAA,EAA2C,EAAE,CAAA,aAAA,EAAgB,KAAK,CAAA,CAAA,CAAA;AAAA,cAClE,EAAE,OAAA,EAAS,WAAY,CAAA,SAAA,CAAU,OAAQ,EAAA;AAAA,aAC3C,CAAA;AAAA,mBACO,KAAO,EAAA;AACd,YAAI,IAAA,KAAA,KAAU,UAAW,CAAA,MAAA,CAAO,MAAQ,EAAA;AACtC,cAAA,MAAA,CAAO,KAAM,CAAA,CAAA,kCAAA,EAAqC,EAAE,CAAA,CAAA,CAAA,EAAK,KAAK,CAAA,CAAA;AAAA,aAChE;AAAA,WACA,SAAA;AAGA,YAAA,MAAM,IAAI,OAAA;AAAA,cAAQ,aAChB,UAAW,CAAA,OAAA,EAAS,IAAI,IAAK,CAAA,MAAA,KAAW,CAAC,CAAA;AAAA,aAC3C,CAAA;AACA,YAAA,GAAA,CAAI,GAAI,EAAA,CAAA;AAAA,WACV;AAAA,SACF;AAAA,OACA,SAAA;AACA,QAAA,UAAA,CAAW,KAAM,EAAA,CAAA;AACjB,QAAA,YAAA,CAAa,OAAO,CAAA,CAAA;AAAA,OACtB;AAAA,KACF;AAAA,GACF,CAAA;AAEA,EAAA,SAAA,CAAU,GAAI,CAAA,uCAAA,EAAyC,OAAO,GAAA,EAAK,GAAQ,KAAA;AACzE,IAAA,MAAM,WAAc,GAAA,MAAM,QAAS,CAAA,WAAA,CAAY,GAAK,EAAA;AAAA,MAClD,KAAA,EAAO,CAAC,SAAS,CAAA;AAAA,KAClB,CAAA,CAAA;AACD,IAAM,MAAA,EAAA,GAAK,IAAI,MAAO,CAAA,cAAA,CAAA;AAEtB,IAAA,MAAM,MAAM,kBAAmB,CAAA,EAAA,EAAI,GAAI,CAAA,IAAA,CAAK,QAAQ,WAAW,CAAA,CAAA;AAE/D,IAAO,MAAA,CAAA,KAAA;AAAA,MACL,CAAA,kBAAA,EAAqB,EAAE,CAAiB,cAAA,EAAA,GAAA,CAAI,KAAK,MAAO,CAAA,IAAA,CAAK,MAAM,CAAC,CAAA,CAAA,CAAA;AAAA,MACpE,EAAE,OAAA,EAAS,WAAY,CAAA,SAAA,CAAU,OAAQ,EAAA;AAAA,KAC3C,CAAA;AAEA,IAAI,GAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,GAAI,EAAA,CAAA;AAAA,GACrB,CAAA,CAAA;AAED,EAAO,OAAA,SAAA,CAAA;AACT;;;;"}

package/migrations/20240523100528_init.js

@@ -0,0 +1,98 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// @ts-check
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = async function up(knex) {
+  // The event bus only supports PostgresSQL
+  if (knex.client.config.client === 'pg') {
+    await knex.schema.createTable('event_bus_events', table => {
+      table.comment('Events published to the events bus');
+      table
+        .bigIncrements('id')
+        .primary()
+        .comment('The unique ID of this event');
+      table
+        .text('created_by')
+        .notNullable()
+        .comment('The principal that published the event');
+      table
+        .dateTime('created_at')
+        .defaultTo(knex.fn.now())
+        .notNullable()
+        .comment('The time that the event was created');
+      table.text('topic').notNullable().comment('The topic of the event');
+      table
+        .text('data_json')
+        .notNullable()
+        .comment('The payload data of this event');
+      table
+        .specificType('notified_subscribers', 'text ARRAY')
+        .comment(
+          'The IDs of the subscribers that have already consumed this event',
+        );
+
+      table.index('topic', 'event_bus_events_topic_idx');
+    });
+
+    await knex.schema.createTable('event_bus_subscriptions', table => {
+      table.comment('Subscriptions to the event bus');
+      table
+        .string('id')
+        .primary()
+        .notNullable()
+        .comment('The unique ID of this particular subscription');
+      table
+        .text('created_by')
+        .notNullable()
+        .comment('The principal that created the subscription');
+      table
+        .dateTime('created_at')
+        .defaultTo(knex.fn.now())
+        .notNullable()
+        .comment('The time that the subscription was created');
+      table
+        .dateTime('updated_at')
+        .defaultTo(knex.fn.now())
+        .notNullable()
+        .comment('The time that the subscription was last updated');
+      table
+        .bigInteger('read_until')
+        .notNullable()
+        .comment(
+          'The sequence counter until which the subscription has read events',
+        );
+      table
+        .specificType('topics', 'text ARRAY')
+        .comment('The topics that this subscriber is interested in');
+    });
+  }
+};
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = async function down(knex) {
+  if (knex.client.config.client === 'pg') {
+    await knex.schema.dropTable('event_bus_subscriptions');
+    await knex.schema.dropTable('event_bus_events');
+  }
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-events-backend",
-  "version": "0.3.12",
+  "version": "0.3.13-next.1",
   "backstage": {
     "role": "backend-plugin",
     "pluginId": "events",
@@ -27,6 +27,7 @@
       "default": "./dist/index.cjs.js"
     },
     "./alpha": {
+      "backstage": "@backstage/BackendFeature",
       "require": "./dist/alpha.cjs.js",
       "types": "./dist/alpha.d.ts",
       "default": "./dist/alpha.cjs.js"
@@ -38,11 +39,13 @@
   "files": [
     "config.d.ts",
     "dist",
+    "migrations",
     "alpha"
   ],
   "scripts": {
     "build": "backstage-cli package build",
     "clean": "backstage-cli package clean",
+    "generate": "backstage-repo-tools package schema openapi generate --server --client-package plugins/events-node",
     "lint": "backstage-cli package lint",
     "prepack": "backstage-cli package prepack",
     "postpack": "backstage-cli package postpack",
@@ -51,19 +54,25 @@
   },
   "dependencies": {
     "@backstage/backend-common": "^0.25.0",
-    "@backstage/backend-plugin-api": "^1.0.0",
-    "@backstage/config": "^1.2.0",
-    "@backstage/plugin-events-node": "^0.4.0",
+    "@backstage/backend-openapi-utils": "0.2.0-next.1",
+    "@backstage/backend-plugin-api": "1.0.1-next.1",
+    "@backstage/config": "1.2.0",
+    "@backstage/errors": "1.2.4",
+    "@backstage/plugin-events-node": "0.4.1-next.1",
+    "@backstage/types": "1.1.1",
     "@types/express": "^4.17.6",
     "express": "^4.17.1",
     "express-promise-router": "^4.1.0",
+    "knex": "^3.0.0",
     "winston": "^3.2.1"
   },
   "devDependencies": {
-    "@backstage/backend-common": "^0.25.0",
-    "@backstage/backend-test-utils": "^1.0.0",
-    "@backstage/cli": "^0.27.1",
-    "@backstage/plugin-events-backend-test-utils": "^0.1.35",
+    "@backstage/backend-app-api": "1.0.1-next.1",
+    "@backstage/backend-defaults": "0.5.1-next.2",
+    "@backstage/backend-test-utils": "1.0.1-next.2",
+    "@backstage/cli": "0.28.0-next.2",
+    "@backstage/plugin-events-backend-test-utils": "0.1.36-next.1",
+    "@backstage/repo-tools": "0.10.0-next.2",
     "supertest": "^7.0.0"
   },
   "configSchema": "config.d.ts"

package/dist/cjs/HttpPostIngressEventPublisher-D6pQ6awS.cjs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"HttpPostIngressEventPublisher-D6pQ6awS.cjs.js","sources":["../../src/service/http/validation/RequestValidationContextImpl.ts","../../src/service/http/HttpPostIngressEventPublisher.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  RequestRejectionDetails,\n  RequestValidationContext,\n} from '@backstage/plugin-events-node';\n\nexport class RequestValidationContextImpl implements RequestValidationContext {\n  #rejectionDetails: RequestRejectionDetails | undefined;\n\n  reject(details?: Partial<RequestRejectionDetails>): void {\n    this.#rejectionDetails = {\n      status: details?.status ?? 403,\n      payload: details?.payload ?? {},\n    };\n  }\n\n  wasRejected(): boolean {\n    return this.#rejectionDetails !== undefined;\n  }\n\n  get rejectionDetails() {\n    return this.#rejectionDetails;\n  }\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { errorHandler } from '@backstage/backend-common';\nimport { LoggerService } from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\nimport {\n  EventsService,\n  HttpPostIngressOptions,\n  RequestValidator,\n} from '@backstage/plugin-events-node';\nimport express from 'express';\nimport Router from 'express-promise-router';\nimport { RequestValidationContextImpl } from './validation';\n\n/**\n * Publishes events received from their origin (e.g., webhook events from an SCM system)\n * via HTTP POST endpoint and passes the request body as event payload to the registered subscribers.\n *\n * @public\n */\n// TODO(pjungermann): add prom metrics? (see plugins/catalog-backend/src/util/metrics.ts, etc.)\nexport class HttpPostIngressEventPublisher {\n  static fromConfig(env: {\n    config: Config;\n    events: EventsService;\n    ingresses?: { [topic: string]: Omit<HttpPostIngressOptions, 'topic'> };\n    logger: LoggerService;\n  }): HttpPostIngressEventPublisher {\n    const topics =\n      env.config.getOptionalStringArray('events.http.topics') ?? [];\n\n    const ingresses = env.ingresses ?? {};\n    topics.forEach(topic => {\n      // don't overwrite topic settings\n      // (e.g., added at the config as well as argument)\n      if (!ingresses[topic]) {\n        ingresses[topic] = {};\n      }\n    });\n\n    return new HttpPostIngressEventPublisher(env.events, env.logger, ingresses);\n  }\n\n  private constructor(\n    private readonly events: EventsService,\n    private readonly logger: LoggerService,\n    private readonly ingresses: {\n      [topic: string]: Omit<HttpPostIngressOptions, 'topic'>;\n    },\n  ) {}\n\n  bind(router: express.Router): void {\n    router.use('/http', this.createRouter(this.ingresses));\n  }\n\n  private createRouter(ingresses: {\n    [topic: string]: Omit<HttpPostIngressOptions, 'topic'>;\n  }): express.Router {\n    const router = Router();\n    router.use(express.json());\n\n    Object.keys(ingresses).forEach(topic =>\n      this.addRouteForTopic(router, topic, ingresses[topic].validator),\n    );\n\n    router.use(errorHandler());\n    return router;\n  }\n\n  private addRouteForTopic(\n    router: express.Router,\n    topic: string,\n    validator?: RequestValidator,\n  ): void {\n    const path = `/${topic}`;\n\n    router.post(path, async (request, response) => {\n      const requestDetails = {\n        body: request.body,\n        headers: request.headers,\n      };\n      const context = new RequestValidationContextImpl();\n      await validator?.(requestDetails, context);\n      if (context.wasRejected()) {\n        response\n          .status(context.rejectionDetails!.status)\n          .json(context.rejectionDetails!.payload);\n        return;\n      }\n\n      const eventPayload = request.body;\n      await this.events.publish({\n        topic,\n        eventPayload,\n        metadata: request.headers,\n      });\n\n      response.status(202).json({ status: 'accepted' });\n    });\n\n    // TODO(pjungermann): We don't really know the externally defined path prefix here,\n    //  however it is more useful for users to have it. Is there a better way?\n    this.logger.info(`Registered /api/events/http${path} to receive events`);\n  }\n}\n"],"names":["Router","express","errorHandler"],"mappings":";;;;;;;;;;;AAqBO,MAAM,4BAAiE,CAAA;AAAA,EAC5E,iBAAA,CAAA;AAAA,EAEA,OAAO,OAAkD,EAAA;AACvD,IAAA,IAAA,CAAK,iBAAoB,GAAA;AAAA,MACvB,MAAA,EAAQ,SAAS,MAAU,IAAA,GAAA;AAAA,MAC3B,OAAA,EAAS,OAAS,EAAA,OAAA,IAAW,EAAC;AAAA,KAChC,CAAA;AAAA,GACF;AAAA,EAEA,WAAuB,GAAA;AACrB,IAAA,OAAO,KAAK,iBAAsB,KAAA,KAAA,CAAA,CAAA;AAAA,GACpC;AAAA,EAEA,IAAI,gBAAmB,GAAA;AACrB,IAAA,OAAO,IAAK,CAAA,iBAAA,CAAA;AAAA,GACd;AACF;;ACHO,MAAM,6BAA8B,CAAA;AAAA,EAsBjC,WAAA,CACW,MACA,EAAA,MAAA,EACA,SAGjB,EAAA;AALiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA,CAAA;AAAA,GAGhB;AAAA,EA3BH,OAAO,WAAW,GAKgB,EAAA;AAChC,IAAA,MAAM,SACJ,GAAI,CAAA,MAAA,CAAO,sBAAuB,CAAA,oBAAoB,KAAK,EAAC,CAAA;AAE9D,IAAM,MAAA,SAAA,GAAY,GAAI,CAAA,SAAA,IAAa,EAAC,CAAA;AACpC,IAAA,MAAA,CAAO,QAAQ,CAAS,KAAA,KAAA;AAGtB,MAAI,IAAA,CAAC,SAAU,CAAA,KAAK,CAAG,EAAA;AACrB,QAAU,SAAA,CAAA,KAAK,IAAI,EAAC,CAAA;AAAA,OACtB;AAAA,KACD,CAAA,CAAA;AAED,IAAA,OAAO,IAAI,6BAA8B,CAAA,GAAA,CAAI,MAAQ,EAAA,GAAA,CAAI,QAAQ,SAAS,CAAA,CAAA;AAAA,GAC5E;AAAA,EAUA,KAAK,MAA8B,EAAA;AACjC,IAAA,MAAA,CAAO,IAAI,OAAS,EAAA,IAAA,CAAK,YAAa,CAAA,IAAA,CAAK,SAAS,CAAC,CAAA,CAAA;AAAA,GACvD;AAAA,EAEQ,aAAa,SAEF,EAAA;AACjB,IAAA,MAAM,SAASA,uBAAO,EAAA,CAAA;AACtB,IAAO,MAAA,CAAA,GAAA,CAAIC,wBAAQ,CAAA,IAAA,EAAM,CAAA,CAAA;AAEzB,IAAO,MAAA,CAAA,IAAA,CAAK,SAAS,CAAE,CAAA,OAAA;AAAA,MAAQ,CAAA,KAAA,KAC7B,KAAK,gBAAiB,CAAA,MAAA,EAAQ,OAAO,SAAU,CAAA,KAAK,EAAE,SAAS,CAAA;AAAA,KACjE,CAAA;AAEA,IAAO,MAAA,CAAA,GAAA,CAAIC,4BAAc,CAAA,CAAA;AACzB,IAAO,OAAA,MAAA,CAAA;AAAA,GACT;AAAA,EAEQ,gBAAA,CACN,MACA,EAAA,KAAA,EACA,SACM,EAAA;AACN,IAAM,MAAA,IAAA,GAAO,IAAI,KAAK,CAAA,CAAA,CAAA;AAEtB,IAAA,MAAA,CAAO,IAAK,CAAA,IAAA,EAAM,OAAO,OAAA,EAAS,QAAa,KAAA;AAC7C,MAAA,MAAM,cAAiB,GAAA;AAAA,QACrB,MAAM,OAAQ,CAAA,IAAA;AAAA,QACd,SAAS,OAAQ,CAAA,OAAA;AAAA,OACnB,CAAA;AACA,MAAM,MAAA,OAAA,GAAU,IAAI,4BAA6B,EAAA,CAAA;AACjD,MAAM,MAAA,SAAA,GAAY,gBAAgB,OAAO,CAAA,CAAA;AACzC,MAAI,IAAA,OAAA,CAAQ,aAAe,EAAA;AACzB,QACG,QAAA,CAAA,MAAA,CAAO,QAAQ,gBAAkB,CAAA,MAAM,EACvC,IAAK,CAAA,OAAA,CAAQ,iBAAkB,OAAO,CAAA,CAAA;AACzC,QAAA,OAAA;AAAA,OACF;AAEA,MAAA,MAAM,eAAe,OAAQ,CAAA,IAAA,CAAA;AAC7B,MAAM,MAAA,IAAA,CAAK,OAAO,OAAQ,CAAA;AAAA,QACxB,KAAA;AAAA,QACA,YAAA;AAAA,QACA,UAAU,OAAQ,CAAA,OAAA;AAAA,OACnB,CAAA,CAAA;AAED,MAAA,QAAA,CAAS,OAAO,GAAG,CAAA,CAAE,KAAK,EAAE,MAAA,EAAQ,YAAY,CAAA,CAAA;AAAA,KACjD,CAAA,CAAA;AAID,IAAA,IAAA,CAAK,MAAO,CAAA,IAAA,CAAK,CAA8B,2BAAA,EAAA,IAAI,CAAoB,kBAAA,CAAA,CAAA,CAAA;AAAA,GACzE;AACF;;;;"}