@backstage/plugin-events-node 0.4.5 → 0.4.6-next.1

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @backstage/plugin-events-node
 
+## 0.4.6-next.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.1.0-next.1
+  - @backstage/errors@1.2.5
+  - @backstage/types@1.2.0
+
+## 0.4.6-next.0
+
+### Patch Changes
+
+- 79a06f6: Clarified purpose of subscriber ID in TSDoc for `EventsServiceSubscribeOptions`.
+- 1577511: Allow configuring a timeout for event bus polling requests. This can be set like so in your app-config:
+
+  ```yaml
+  events:
+    notifyTimeoutMs: 30000
+  ```
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.0.3-next.0
+  - @backstage/errors@1.2.5
+  - @backstage/types@1.2.0
+
 ## 0.4.5
 
 ### Patch Changes

package/dist/api/DefaultEventsService.cjs.js

@@ -1,5 +1,6 @@
 'use strict';
 
+var EventsService = require('./EventsService.cjs.js');
 var DefaultApi_client = require('../generated/apis/DefaultApi.client.cjs.js');
 var errors = require('@backstage/errors');
 
@@ -137,7 +138,19 @@ class PluginEventsService {
           );
           if (res.status === 202) {
             lock.release();
-            await res.text();
+            const notifyTimeoutHeader = res.headers.get(
+              EventsService.EVENTS_NOTIFY_TIMEOUT_HEADER
+            );
+            const notifyTimeoutMs = notifyTimeoutHeader && !isNaN(parseInt(notifyTimeoutHeader, 10)) ? Number(notifyTimeoutHeader) + 1e3 : null;
+            await Promise.race(
+              [
+                // We don't actually expect any response body here, but waiting for
+                // an empty body to be returned has been more reliable that waiting
+                // for the response body stream to close.
+                res.text(),
+                notifyTimeoutMs ? new Promise((resolve) => setTimeout(resolve, notifyTimeoutMs)) : null
+              ].filter(Boolean)
+            );
           } else if (res.status === 200) {
             const data = await res.json();
             if (data) {

package/dist/api/DefaultEventsService.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"DefaultEventsService.cjs.js","sources":["../../src/api/DefaultEventsService.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  AuthService,\n  DiscoveryService,\n  LifecycleService,\n  LoggerService,\n  RootConfigService,\n} from '@backstage/backend-plugin-api';\nimport { EventParams } from './EventParams';\nimport { EventsService, EventsServiceSubscribeOptions } from './EventsService';\nimport { DefaultApiClient } from '../generated';\nimport { ResponseError } from '@backstage/errors';\n\nconst POLL_BACKOFF_START_MS = 1_000;\nconst POLL_BACKOFF_MAX_MS = 60_000;\nconst POLL_BACKOFF_FACTOR = 2;\n\nconst EVENT_BUS_MODES = ['never', 'always', 'auto'] as const;\n\n/**\n * @public\n */\nexport type EventBusMode = 'never' | 'always' | 'auto';\n\n/**\n * Local event bus for subscribers within the same process.\n *\n * When publishing events we'll keep track of which subscribers we managed to\n * reach locally, and forward those subscriber IDs to the events backend if it\n * is in use. The events backend will then both avoid forwarding the same events\n * to those subscribers again, but also avoid storing the event altogether if\n * there are no other subscribers.\n * @internal\n */\nexport class LocalEventBus {\n  readonly #logger: LoggerService;\n\n  readonly #subscribers = new Map<\n    string,\n    Omit<EventsServiceSubscribeOptions, 'topics'>[]\n  >();\n\n  constructor(logger: LoggerService) {\n    this.#logger = logger;\n  }\n\n  async publish(\n    params: EventParams,\n  ): Promise<{ notifiedSubscribers: string[] }> {\n    this.#logger.debug(\n      `Event received: topic=${params.topic}, metadata=${JSON.stringify(\n        params.metadata,\n      )}, payload=${JSON.stringify(params.eventPayload)}`,\n    );\n\n    if (!this.#subscribers.has(params.topic)) {\n      return { notifiedSubscribers: [] };\n    }\n\n    const onEventPromises: Promise<string>[] = [];\n    this.#subscribers.get(params.topic)?.forEach(subscription => {\n      onEventPromises.push(\n        (async () => {\n          try {\n            await subscription.onEvent(params);\n          } catch (error) {\n            this.#logger.warn(\n              `Subscriber \"${subscription.id}\" failed to process event for topic \"${params.topic}\"`,\n              error,\n            );\n          }\n          return subscription.id;\n        })(),\n      );\n    });\n\n    return { notifiedSubscribers: await Promise.all(onEventPromises) };\n  }\n\n  async subscribe(options: EventsServiceSubscribeOptions): Promise<void> {\n    options.topics.forEach(topic => {\n      if (!this.#subscribers.has(topic)) {\n        this.#subscribers.set(topic, []);\n      }\n\n      this.#subscribers.get(topic)!.push({\n        id: options.id,\n        onEvent: options.onEvent,\n      });\n    });\n  }\n}\n\n/**\n * Plugin specific events bus that delegates to the local bus, as well as the\n * events backend if it is available.\n */\nclass PluginEventsService implements EventsService {\n  constructor(\n    private readonly pluginId: string,\n    private readonly localBus: LocalEventBus,\n    private readonly logger: LoggerService,\n    private readonly mode: EventBusMode,\n    private client?: DefaultApiClient,\n    private readonly auth?: AuthService,\n  ) {}\n\n  async publish(params: EventParams): Promise<void> {\n    const lock = this.#getShutdownLock();\n    if (!lock) {\n      throw new Error('Service is shutting down');\n    }\n    try {\n      const { notifiedSubscribers } = await this.localBus.publish(params);\n\n      const client = this.client;\n      if (!client) {\n        return;\n      }\n      const token = await this.#getToken();\n      if (!token) {\n        return;\n      }\n      const res = await client.postEvent(\n        {\n          body: {\n            event: { payload: params.eventPayload, topic: params.topic },\n            notifiedSubscribers,\n          },\n        },\n        { token },\n      );\n\n      if (!res.ok) {\n        if (res.status === 404 && this.mode !== 'always') {\n          this.logger.warn(\n            `Event publish request failed with status 404, events backend not found. Future events will not be persisted.`,\n          );\n          delete this.client;\n          return;\n        }\n        throw await ResponseError.fromResponse(res);\n      }\n    } finally {\n      lock.release();\n    }\n  }\n\n  async subscribe(options: EventsServiceSubscribeOptions): Promise<void> {\n    const subscriptionId = `${this.pluginId}.${options.id}`;\n\n    await this.localBus.subscribe({\n      id: subscriptionId,\n      topics: options.topics,\n      onEvent: options.onEvent,\n    });\n\n    if (!this.client) {\n      return;\n    }\n\n    this.#startPolling(subscriptionId, options.topics, options.onEvent);\n  }\n\n  #startPolling(\n    subscriptionId: string,\n    topics: string[],\n    onEvent: EventsServiceSubscribeOptions['onEvent'],\n  ) {\n    let hasSubscription = false;\n    let backoffMs = POLL_BACKOFF_START_MS;\n    const poll = async () => {\n      const client = this.client;\n      if (!client) {\n        return;\n      }\n      const lock = this.#getShutdownLock();\n      if (!lock) {\n        return; // shutting down\n      }\n      try {\n        const token = await this.#getToken();\n        if (!token) {\n          return;\n        }\n\n        if (hasSubscription) {\n          const res = await client.getSubscriptionEvents(\n            {\n              path: { subscriptionId },\n            },\n            { token },\n          );\n\n          if (res.status === 202) {\n            // 202 means there were no immediately available events, but the\n            // response will block until either new events are available or the\n            // request times out. In both cases we should should try to read events\n            // immediately again\n\n            lock.release();\n            // We don't actually expect any response body here, but waiting for\n            // an empty body to be returned has been more reliable that waiting\n            // for the response body stream to close.\n            await res.text();\n          } else if (res.status === 200) {\n            const data = await res.json();\n            if (data) {\n              for (const event of data.events ?? []) {\n                try {\n                  await onEvent({\n                    topic: event.topic,\n                    eventPayload: event.payload,\n                  });\n                } catch (error) {\n                  this.logger.warn(\n                    `Subscriber \"${subscriptionId}\" failed to process event for topic \"${event.topic}\"`,\n                    error,\n                  );\n                }\n              }\n            }\n          } else {\n            if (res.status === 404) {\n              this.logger.info(\n                `Polling event subscription resulted in a 404, recreating subscription`,\n              );\n              hasSubscription = false;\n            } else {\n              throw await ResponseError.fromResponse(res);\n            }\n          }\n        }\n\n        // If we haven't yet created the subscription, or if it was removed, create a new one\n        if (!hasSubscription) {\n          const res = await client.putSubscription(\n            {\n              path: { subscriptionId },\n              body: { topics },\n            },\n            { token },\n          );\n          hasSubscription = true;\n          if (!res.ok) {\n            if (res.status === 404 && this.mode !== 'always') {\n              this.logger.warn(\n                `Event subscribe request failed with status 404, events backend not found. Will only receive events that were sent locally on this process.`,\n              );\n              // Events backend is not present and not configured to always be used, bail out and stop polling\n              delete this.client;\n              return;\n            }\n            throw await ResponseError.fromResponse(res);\n          }\n        }\n\n        // No errors, reset backoff\n        backoffMs = POLL_BACKOFF_START_MS;\n\n        process.nextTick(poll);\n      } catch (error) {\n        this.logger.warn(\n          `Poll failed for subscription \"${subscriptionId}\", retrying in ${backoffMs.toFixed(\n            0,\n          )}ms`,\n          error,\n        );\n        setTimeout(poll, backoffMs);\n        backoffMs = Math.min(\n          backoffMs * POLL_BACKOFF_FACTOR,\n          POLL_BACKOFF_MAX_MS,\n        );\n      } finally {\n        lock.release();\n      }\n    };\n    poll();\n  }\n\n  async #getToken() {\n    if (!this.auth) {\n      throw new Error('Auth service not available');\n    }\n\n    try {\n      const { token } = await this.auth.getPluginRequestToken({\n        onBehalfOf: await this.auth.getOwnServiceCredentials(),\n        targetPluginId: 'events',\n      });\n      return token;\n    } catch (error) {\n      // This is a bit hacky, but handles the case where new auth is used\n      // without legacy auth fallback, and the events backend is not installed\n      if (\n        String(error).includes('Unable to generate legacy token') &&\n        this.mode !== 'always'\n      ) {\n        this.logger.warn(\n          `The events backend is not available and neither is legacy auth. Future events will not be persisted.`,\n        );\n        delete this.client;\n        return undefined;\n      }\n      throw error;\n    }\n  }\n\n  async shutdown() {\n    this.#isShuttingDown = true;\n    await Promise.all(this.#shutdownLocks);\n  }\n\n  #isShuttingDown = false;\n  #shutdownLocks = new Set<Promise<void>>();\n\n  // This locking mechanism helps ensure that we are either idle or waiting for\n  // a blocked events call before shutting down. It increases out changes of\n  // never dropping any events on shutdown.\n  #getShutdownLock(): { release(): void } | undefined {\n    if (this.#isShuttingDown) {\n      return undefined;\n    }\n\n    let release: () => void;\n\n    const lock = new Promise<void>(resolve => {\n      release = () => {\n        resolve();\n        this.#shutdownLocks.delete(lock);\n      };\n    });\n    this.#shutdownLocks.add(lock);\n    return { release: release! };\n  }\n}\n\n/**\n * In-process event broker which will pass the event to all registered subscribers\n * interested in it.\n * Events will not be persisted in any form.\n * Events will not be passed to subscribers at other instances of the same cluster.\n *\n * @public\n */\n// TODO(pjungermann): add opentelemetry? (see plugins/catalog-backend/src/util/opentelemetry.ts, etc.)\nexport class DefaultEventsService implements EventsService {\n  private constructor(\n    private readonly logger: LoggerService,\n    private readonly localBus: LocalEventBus,\n    private readonly mode: EventBusMode,\n  ) {}\n\n  static create(options: {\n    logger: LoggerService;\n    config?: RootConfigService;\n    useEventBus?: EventBusMode;\n  }): DefaultEventsService {\n    const eventBusMode =\n      options.useEventBus ??\n      ((options.config?.getOptionalString('events.useEventBus') ??\n        'auto') as EventBusMode);\n    if (!EVENT_BUS_MODES.includes(eventBusMode)) {\n      throw new Error(\n        `Invalid events.useEventBus config, must be one of ${EVENT_BUS_MODES.join(\n          ', ',\n        )}, got '${eventBusMode}'`,\n      );\n    }\n\n    return new DefaultEventsService(\n      options.logger,\n      new LocalEventBus(options.logger),\n      eventBusMode,\n    );\n  }\n\n  /**\n   * Returns a plugin-scoped context of the `EventService`\n   * that ensures to prefix subscriber IDs with the plugin ID.\n   *\n   * @param pluginId - The plugin that the `EventService` should be created for.\n   */\n  forPlugin(\n    pluginId: string,\n    options?: {\n      discovery: DiscoveryService;\n      logger: LoggerService;\n      auth: AuthService;\n      lifecycle: LifecycleService;\n    },\n  ): EventsService {\n    const client =\n      options && this.mode !== 'never'\n        ? new DefaultApiClient({\n            discoveryApi: options.discovery,\n            fetchApi: { fetch }, // use native node fetch\n          })\n        : undefined;\n    const logger = options?.logger ?? this.logger;\n    const service = new PluginEventsService(\n      pluginId,\n      this.localBus,\n      logger,\n      this.mode,\n      client,\n      options?.auth,\n    );\n    options?.lifecycle.addShutdownHook(async () => {\n      await service.shutdown();\n    });\n    return service;\n  }\n\n  async publish(params: EventParams): Promise<void> {\n    await this.localBus.publish(params);\n  }\n\n  async subscribe(options: EventsServiceSubscribeOptions): Promise<void> {\n    this.localBus.subscribe(options);\n  }\n}\n"],"names":["ResponseError","DefaultApiClient"],"mappings":";;;;;AA4BA,MAAM,qBAAwB,GAAA,GAAA;AAC9B,MAAM,mBAAsB,GAAA,GAAA;AAC5B,MAAM,mBAAsB,GAAA,CAAA;AAE5B,MAAM,eAAkB,GAAA,CAAC,OAAS,EAAA,QAAA,EAAU,MAAM,CAAA;AAiB3C,MAAM,aAAc,CAAA;AAAA,EAChB,OAAA;AAAA,EAEA,YAAA,uBAAmB,GAG1B,EAAA;AAAA,EAEF,YAAY,MAAuB,EAAA;AACjC,IAAA,IAAA,CAAK,OAAU,GAAA,MAAA;AAAA;AACjB,EAEA,MAAM,QACJ,MAC4C,EAAA;AAC5C,IAAA,IAAA,CAAK,OAAQ,CAAA,KAAA;AAAA,MACX,CAAyB,sBAAA,EAAA,MAAA,CAAO,KAAK,CAAA,WAAA,EAAc,IAAK,CAAA,SAAA;AAAA,QACtD,MAAO,CAAA;AAAA,OACR,CAAa,UAAA,EAAA,IAAA,CAAK,SAAU,CAAA,MAAA,CAAO,YAAY,CAAC,CAAA;AAAA,KACnD;AAEA,IAAA,IAAI,CAAC,IAAK,CAAA,YAAA,CAAa,GAAI,CAAA,MAAA,CAAO,KAAK,CAAG,EAAA;AACxC,MAAO,OAAA,EAAE,mBAAqB,EAAA,EAAG,EAAA;AAAA;AAGnC,IAAA,MAAM,kBAAqC,EAAC;AAC5C,IAAA,IAAA,CAAK,aAAa,GAAI,CAAA,MAAA,CAAO,KAAK,CAAA,EAAG,QAAQ,CAAgB,YAAA,KAAA;AAC3D,MAAgB,eAAA,CAAA,IAAA;AAAA,QAAA,CACb,YAAY;AACX,UAAI,IAAA;AACF,YAAM,MAAA,YAAA,CAAa,QAAQ,MAAM,CAAA;AAAA,mBAC1B,KAAO,EAAA;AACd,YAAA,IAAA,CAAK,OAAQ,CAAA,IAAA;AAAA,cACX,CAAe,YAAA,EAAA,YAAA,CAAa,EAAE,CAAA,qCAAA,EAAwC,OAAO,KAAK,CAAA,CAAA,CAAA;AAAA,cAClF;AAAA,aACF;AAAA;AAEF,UAAA,OAAO,YAAa,CAAA,EAAA;AAAA,SACnB;AAAA,OACL;AAAA,KACD,CAAA;AAED,IAAA,OAAO,EAAE,mBAAqB,EAAA,MAAM,OAAQ,CAAA,GAAA,CAAI,eAAe,CAAE,EAAA;AAAA;AACnE,EAEA,MAAM,UAAU,OAAuD,EAAA;AACrE,IAAQ,OAAA,CAAA,MAAA,CAAO,QAAQ,CAAS,KAAA,KAAA;AAC9B,MAAA,IAAI,CAAC,IAAA,CAAK,YAAa,CAAA,GAAA,CAAI,KAAK,CAAG,EAAA;AACjC,QAAA,IAAA,CAAK,YAAa,CAAA,GAAA,CAAI,KAAO,EAAA,EAAE,CAAA;AAAA;AAGjC,MAAA,IAAA,CAAK,YAAa,CAAA,GAAA,CAAI,KAAK,CAAA,CAAG,IAAK,CAAA;AAAA,QACjC,IAAI,OAAQ,CAAA,EAAA;AAAA,QACZ,SAAS,OAAQ,CAAA;AAAA,OAClB,CAAA;AAAA,KACF,CAAA;AAAA;AAEL;AAMA,MAAM,mBAA6C,CAAA;AAAA,EACjD,YACmB,QACA,EAAA,QAAA,EACA,MACA,EAAA,IAAA,EACT,QACS,IACjB,EAAA;AANiB,IAAA,IAAA,CAAA,QAAA,GAAA,QAAA;AACA,IAAA,IAAA,CAAA,QAAA,GAAA,QAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA;AACT,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACS,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA;AAAA;AAChB,EAEH,MAAM,QAAQ,MAAoC,EAAA;AAChD,IAAM,MAAA,IAAA,GAAO,KAAK,gBAAiB,EAAA;AACnC,IAAA,IAAI,CAAC,IAAM,EAAA;AACT,MAAM,MAAA,IAAI,MAAM,0BAA0B,CAAA;AAAA;AAE5C,IAAI,IAAA;AACF,MAAA,MAAM,EAAE,mBAAoB,EAAA,GAAI,MAAM,IAAK,CAAA,QAAA,CAAS,QAAQ,MAAM,CAAA;AAElE,MAAA,MAAM,SAAS,IAAK,CAAA,MAAA;AACpB,MAAA,IAAI,CAAC,MAAQ,EAAA;AACX,QAAA;AAAA;AAEF,MAAM,MAAA,KAAA,GAAQ,MAAM,IAAA,CAAK,SAAU,EAAA;AACnC,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAA;AAAA;AAEF,MAAM,MAAA,GAAA,GAAM,MAAM,MAAO,CAAA,SAAA;AAAA,QACvB;AAAA,UACE,IAAM,EAAA;AAAA,YACJ,OAAO,EAAE,OAAA,EAAS,OAAO,YAAc,EAAA,KAAA,EAAO,OAAO,KAAM,EAAA;AAAA,YAC3D;AAAA;AACF,SACF;AAAA,QACA,EAAE,KAAM;AAAA,OACV;AAEA,MAAI,IAAA,CAAC,IAAI,EAAI,EAAA;AACX,QAAA,IAAI,GAAI,CAAA,MAAA,KAAW,GAAO,IAAA,IAAA,CAAK,SAAS,QAAU,EAAA;AAChD,UAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,YACV,CAAA,4GAAA;AAAA,WACF;AACA,UAAA,OAAO,IAAK,CAAA,MAAA;AACZ,UAAA;AAAA;AAEF,QAAM,MAAA,MAAMA,oBAAc,CAAA,YAAA,CAAa,GAAG,CAAA;AAAA;AAC5C,KACA,SAAA;AACA,MAAA,IAAA,CAAK,OAAQ,EAAA;AAAA;AACf;AACF,EAEA,MAAM,UAAU,OAAuD,EAAA;AACrE,IAAA,MAAM,iBAAiB,CAAG,EAAA,IAAA,CAAK,QAAQ,CAAA,CAAA,EAAI,QAAQ,EAAE,CAAA,CAAA;AAErD,IAAM,MAAA,IAAA,CAAK,SAAS,SAAU,CAAA;AAAA,MAC5B,EAAI,EAAA,cAAA;AAAA,MACJ,QAAQ,OAAQ,CAAA,MAAA;AAAA,MAChB,SAAS,OAAQ,CAAA;AAAA,KAClB,CAAA;AAED,IAAI,IAAA,CAAC,KAAK,MAAQ,EAAA;AAChB,MAAA;AAAA;AAGF,IAAA,IAAA,CAAK,aAAc,CAAA,cAAA,EAAgB,OAAQ,CAAA,MAAA,EAAQ,QAAQ,OAAO,CAAA;AAAA;AACpE,EAEA,aAAA,CACE,cACA,EAAA,MAAA,EACA,OACA,EAAA;AACA,IAAA,IAAI,eAAkB,GAAA,KAAA;AACtB,IAAA,IAAI,SAAY,GAAA,qBAAA;AAChB,IAAA,MAAM,OAAO,YAAY;AACvB,MAAA,MAAM,SAAS,IAAK,CAAA,MAAA;AACpB,MAAA,IAAI,CAAC,MAAQ,EAAA;AACX,QAAA;AAAA;AAEF,MAAM,MAAA,IAAA,GAAO,KAAK,gBAAiB,EAAA;AACnC,MAAA,IAAI,CAAC,IAAM,EAAA;AACT,QAAA;AAAA;AAEF,MAAI,IAAA;AACF,QAAM,MAAA,KAAA,GAAQ,MAAM,IAAA,CAAK,SAAU,EAAA;AACnC,QAAA,IAAI,CAAC,KAAO,EAAA;AACV,UAAA;AAAA;AAGF,QAAA,IAAI,eAAiB,EAAA;AACnB,UAAM,MAAA,GAAA,GAAM,MAAM,MAAO,CAAA,qBAAA;AAAA,YACvB;AAAA,cACE,IAAA,EAAM,EAAE,cAAe;AAAA,aACzB;AAAA,YACA,EAAE,KAAM;AAAA,WACV;AAEA,UAAI,IAAA,GAAA,CAAI,WAAW,GAAK,EAAA;AAMtB,YAAA,IAAA,CAAK,OAAQ,EAAA;AAIb,YAAA,MAAM,IAAI,IAAK,EAAA;AAAA,WACjB,MAAA,IAAW,GAAI,CAAA,MAAA,KAAW,GAAK,EAAA;AAC7B,YAAM,MAAA,IAAA,GAAO,MAAM,GAAA,CAAI,IAAK,EAAA;AAC5B,YAAA,IAAI,IAAM,EAAA;AACR,cAAA,KAAA,MAAW,KAAS,IAAA,IAAA,CAAK,MAAU,IAAA,EAAI,EAAA;AACrC,gBAAI,IAAA;AACF,kBAAA,MAAM,OAAQ,CAAA;AAAA,oBACZ,OAAO,KAAM,CAAA,KAAA;AAAA,oBACb,cAAc,KAAM,CAAA;AAAA,mBACrB,CAAA;AAAA,yBACM,KAAO,EAAA;AACd,kBAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,oBACV,CAAe,YAAA,EAAA,cAAc,CAAwC,qCAAA,EAAA,KAAA,CAAM,KAAK,CAAA,CAAA,CAAA;AAAA,oBAChF;AAAA,mBACF;AAAA;AACF;AACF;AACF,WACK,MAAA;AACL,YAAI,IAAA,GAAA,CAAI,WAAW,GAAK,EAAA;AACtB,cAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,gBACV,CAAA,qEAAA;AAAA,eACF;AACA,cAAkB,eAAA,GAAA,KAAA;AAAA,aACb,MAAA;AACL,cAAM,MAAA,MAAMA,oBAAc,CAAA,YAAA,CAAa,GAAG,CAAA;AAAA;AAC5C;AACF;AAIF,QAAA,IAAI,CAAC,eAAiB,EAAA;AACpB,UAAM,MAAA,GAAA,GAAM,MAAM,MAAO,CAAA,eAAA;AAAA,YACvB;AAAA,cACE,IAAA,EAAM,EAAE,cAAe,EAAA;AAAA,cACvB,IAAA,EAAM,EAAE,MAAO;AAAA,aACjB;AAAA,YACA,EAAE,KAAM;AAAA,WACV;AACA,UAAkB,eAAA,GAAA,IAAA;AAClB,UAAI,IAAA,CAAC,IAAI,EAAI,EAAA;AACX,YAAA,IAAI,GAAI,CAAA,MAAA,KAAW,GAAO,IAAA,IAAA,CAAK,SAAS,QAAU,EAAA;AAChD,cAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,gBACV,CAAA,0IAAA;AAAA,eACF;AAEA,cAAA,OAAO,IAAK,CAAA,MAAA;AACZ,cAAA;AAAA;AAEF,YAAM,MAAA,MAAMA,oBAAc,CAAA,YAAA,CAAa,GAAG,CAAA;AAAA;AAC5C;AAIF,QAAY,SAAA,GAAA,qBAAA;AAEZ,QAAA,OAAA,CAAQ,SAAS,IAAI,CAAA;AAAA,eACd,KAAO,EAAA;AACd,QAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,UACV,CAAA,8BAAA,EAAiC,cAAc,CAAA,eAAA,EAAkB,SAAU,CAAA,OAAA;AAAA,YACzE;AAAA,WACD,CAAA,EAAA,CAAA;AAAA,UACD;AAAA,SACF;AACA,QAAA,UAAA,CAAW,MAAM,SAAS,CAAA;AAC1B,QAAA,SAAA,GAAY,IAAK,CAAA,GAAA;AAAA,UACf,SAAY,GAAA,mBAAA;AAAA,UACZ;AAAA,SACF;AAAA,OACA,SAAA;AACA,QAAA,IAAA,CAAK,OAAQ,EAAA;AAAA;AACf,KACF;AACA,IAAK,IAAA,EAAA;AAAA;AACP,EAEA,MAAM,SAAY,GAAA;AAChB,IAAI,IAAA,CAAC,KAAK,IAAM,EAAA;AACd,MAAM,MAAA,IAAI,MAAM,4BAA4B,CAAA;AAAA;AAG9C,IAAI,IAAA;AACF,MAAA,MAAM,EAAE,KAAM,EAAA,GAAI,MAAM,IAAA,CAAK,KAAK,qBAAsB,CAAA;AAAA,QACtD,UAAY,EAAA,MAAM,IAAK,CAAA,IAAA,CAAK,wBAAyB,EAAA;AAAA,QACrD,cAAgB,EAAA;AAAA,OACjB,CAAA;AACD,MAAO,OAAA,KAAA;AAAA,aACA,KAAO,EAAA;AAGd,MACE,IAAA,MAAA,CAAO,KAAK,CAAE,CAAA,QAAA,CAAS,iCAAiC,CACxD,IAAA,IAAA,CAAK,SAAS,QACd,EAAA;AACA,QAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,UACV,CAAA,oGAAA;AAAA,SACF;AACA,QAAA,OAAO,IAAK,CAAA,MAAA;AACZ,QAAO,OAAA,KAAA,CAAA;AAAA;AAET,MAAM,MAAA,KAAA;AAAA;AACR;AACF,EAEA,MAAM,QAAW,GAAA;AACf,IAAA,IAAA,CAAK,eAAkB,GAAA,IAAA;AACvB,IAAM,MAAA,OAAA,CAAQ,GAAI,CAAA,IAAA,CAAK,cAAc,CAAA;AAAA;AACvC,EAEA,eAAkB,GAAA,KAAA;AAAA,EAClB,cAAA,uBAAqB,GAAmB,EAAA;AAAA;AAAA;AAAA;AAAA,EAKxC,gBAAoD,GAAA;AAClD,IAAA,IAAI,KAAK,eAAiB,EAAA;AACxB,MAAO,OAAA,KAAA,CAAA;AAAA;AAGT,IAAI,IAAA,OAAA;AAEJ,IAAM,MAAA,IAAA,GAAO,IAAI,OAAA,CAAc,CAAW,OAAA,KAAA;AACxC,MAAA,OAAA,GAAU,MAAM;AACd,QAAQ,OAAA,EAAA;AACR,QAAK,IAAA,CAAA,cAAA,CAAe,OAAO,IAAI,CAAA;AAAA,OACjC;AAAA,KACD,CAAA;AACD,IAAK,IAAA,CAAA,cAAA,CAAe,IAAI,IAAI,CAAA;AAC5B,IAAA,OAAO,EAAE,OAAkB,EAAA;AAAA;AAE/B;AAWO,MAAM,oBAA8C,CAAA;AAAA,EACjD,WAAA,CACW,MACA,EAAA,QAAA,EACA,IACjB,EAAA;AAHiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,QAAA,GAAA,QAAA;AACA,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA;AAAA;AAChB,EAEH,OAAO,OAAO,OAIW,EAAA;AACvB,IAAA,MAAM,eACJ,OAAQ,CAAA,WAAA,KACN,QAAQ,MAAQ,EAAA,iBAAA,CAAkB,oBAAoB,CACtD,IAAA,MAAA,CAAA;AACJ,IAAA,IAAI,CAAC,eAAA,CAAgB,QAAS,CAAA,YAAY,CAAG,EAAA;AAC3C,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,qDAAqD,eAAgB,CAAA,IAAA;AAAA,UACnE;AAAA,SACD,UAAU,YAAY,CAAA,CAAA;AAAA,OACzB;AAAA;AAGF,IAAA,OAAO,IAAI,oBAAA;AAAA,MACT,OAAQ,CAAA,MAAA;AAAA,MACR,IAAI,aAAc,CAAA,OAAA,CAAQ,MAAM,CAAA;AAAA,MAChC;AAAA,KACF;AAAA;AACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,SAAA,CACE,UACA,OAMe,EAAA;AACf,IAAA,MAAM,SACJ,OAAW,IAAA,IAAA,CAAK,IAAS,KAAA,OAAA,GACrB,IAAIC,kCAAiB,CAAA;AAAA,MACnB,cAAc,OAAQ,CAAA,SAAA;AAAA,MACtB,QAAA,EAAU,EAAE,KAAM;AAAA;AAAA,KACnB,CACD,GAAA,KAAA,CAAA;AACN,IAAM,MAAA,MAAA,GAAS,OAAS,EAAA,MAAA,IAAU,IAAK,CAAA,MAAA;AACvC,IAAA,MAAM,UAAU,IAAI,mBAAA;AAAA,MAClB,QAAA;AAAA,MACA,IAAK,CAAA,QAAA;AAAA,MACL,MAAA;AAAA,MACA,IAAK,CAAA,IAAA;AAAA,MACL,MAAA;AAAA,MACA,OAAS,EAAA;AAAA,KACX;AACA,IAAS,OAAA,EAAA,SAAA,CAAU,gBAAgB,YAAY;AAC7C,MAAA,MAAM,QAAQ,QAAS,EAAA;AAAA,KACxB,CAAA;AACD,IAAO,OAAA,OAAA;AAAA;AACT,EAEA,MAAM,QAAQ,MAAoC,EAAA;AAChD,IAAM,MAAA,IAAA,CAAK,QAAS,CAAA,OAAA,CAAQ,MAAM,CAAA;AAAA;AACpC,EAEA,MAAM,UAAU,OAAuD,EAAA;AACrE,IAAK,IAAA,CAAA,QAAA,CAAS,UAAU,OAAO,CAAA;AAAA;AAEnC;;;;;"}
+{"version":3,"file":"DefaultEventsService.cjs.js","sources":["../../src/api/DefaultEventsService.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  AuthService,\n  DiscoveryService,\n  LifecycleService,\n  LoggerService,\n  RootConfigService,\n} from '@backstage/backend-plugin-api';\nimport { EventParams } from './EventParams';\nimport {\n  EVENTS_NOTIFY_TIMEOUT_HEADER,\n  EventsService,\n  EventsServiceSubscribeOptions,\n} from './EventsService';\nimport { DefaultApiClient } from '../generated';\nimport { ResponseError } from '@backstage/errors';\n\nconst POLL_BACKOFF_START_MS = 1_000;\nconst POLL_BACKOFF_MAX_MS = 60_000;\nconst POLL_BACKOFF_FACTOR = 2;\n\nconst EVENT_BUS_MODES = ['never', 'always', 'auto'] as const;\n\n/**\n * @public\n */\nexport type EventBusMode = 'never' | 'always' | 'auto';\n\n/**\n * Local event bus for subscribers within the same process.\n *\n * When publishing events we'll keep track of which subscribers we managed to\n * reach locally, and forward those subscriber IDs to the events backend if it\n * is in use. The events backend will then both avoid forwarding the same events\n * to those subscribers again, but also avoid storing the event altogether if\n * there are no other subscribers.\n * @internal\n */\nexport class LocalEventBus {\n  readonly #logger: LoggerService;\n\n  readonly #subscribers = new Map<\n    string,\n    Omit<EventsServiceSubscribeOptions, 'topics'>[]\n  >();\n\n  constructor(logger: LoggerService) {\n    this.#logger = logger;\n  }\n\n  async publish(\n    params: EventParams,\n  ): Promise<{ notifiedSubscribers: string[] }> {\n    this.#logger.debug(\n      `Event received: topic=${params.topic}, metadata=${JSON.stringify(\n        params.metadata,\n      )}, payload=${JSON.stringify(params.eventPayload)}`,\n    );\n\n    if (!this.#subscribers.has(params.topic)) {\n      return { notifiedSubscribers: [] };\n    }\n\n    const onEventPromises: Promise<string>[] = [];\n    this.#subscribers.get(params.topic)?.forEach(subscription => {\n      onEventPromises.push(\n        (async () => {\n          try {\n            await subscription.onEvent(params);\n          } catch (error) {\n            this.#logger.warn(\n              `Subscriber \"${subscription.id}\" failed to process event for topic \"${params.topic}\"`,\n              error,\n            );\n          }\n          return subscription.id;\n        })(),\n      );\n    });\n\n    return { notifiedSubscribers: await Promise.all(onEventPromises) };\n  }\n\n  async subscribe(options: EventsServiceSubscribeOptions): Promise<void> {\n    options.topics.forEach(topic => {\n      if (!this.#subscribers.has(topic)) {\n        this.#subscribers.set(topic, []);\n      }\n\n      this.#subscribers.get(topic)!.push({\n        id: options.id,\n        onEvent: options.onEvent,\n      });\n    });\n  }\n}\n\n/**\n * Plugin specific events bus that delegates to the local bus, as well as the\n * events backend if it is available.\n */\nclass PluginEventsService implements EventsService {\n  constructor(\n    private readonly pluginId: string,\n    private readonly localBus: LocalEventBus,\n    private readonly logger: LoggerService,\n    private readonly mode: EventBusMode,\n    private client?: DefaultApiClient,\n    private readonly auth?: AuthService,\n  ) {}\n\n  async publish(params: EventParams): Promise<void> {\n    const lock = this.#getShutdownLock();\n    if (!lock) {\n      throw new Error('Service is shutting down');\n    }\n    try {\n      const { notifiedSubscribers } = await this.localBus.publish(params);\n\n      const client = this.client;\n      if (!client) {\n        return;\n      }\n      const token = await this.#getToken();\n      if (!token) {\n        return;\n      }\n      const res = await client.postEvent(\n        {\n          body: {\n            event: { payload: params.eventPayload, topic: params.topic },\n            notifiedSubscribers,\n          },\n        },\n        { token },\n      );\n\n      if (!res.ok) {\n        if (res.status === 404 && this.mode !== 'always') {\n          this.logger.warn(\n            `Event publish request failed with status 404, events backend not found. Future events will not be persisted.`,\n          );\n          delete this.client;\n          return;\n        }\n        throw await ResponseError.fromResponse(res);\n      }\n    } finally {\n      lock.release();\n    }\n  }\n\n  async subscribe(options: EventsServiceSubscribeOptions): Promise<void> {\n    const subscriptionId = `${this.pluginId}.${options.id}`;\n\n    await this.localBus.subscribe({\n      id: subscriptionId,\n      topics: options.topics,\n      onEvent: options.onEvent,\n    });\n\n    if (!this.client) {\n      return;\n    }\n\n    this.#startPolling(subscriptionId, options.topics, options.onEvent);\n  }\n\n  #startPolling(\n    subscriptionId: string,\n    topics: string[],\n    onEvent: EventsServiceSubscribeOptions['onEvent'],\n  ) {\n    let hasSubscription = false;\n    let backoffMs = POLL_BACKOFF_START_MS;\n    const poll = async () => {\n      const client = this.client;\n      if (!client) {\n        return;\n      }\n      const lock = this.#getShutdownLock();\n      if (!lock) {\n        return; // shutting down\n      }\n      try {\n        const token = await this.#getToken();\n        if (!token) {\n          return;\n        }\n\n        if (hasSubscription) {\n          const res = await client.getSubscriptionEvents(\n            {\n              path: { subscriptionId },\n            },\n            { token },\n          );\n\n          if (res.status === 202) {\n            // 202 means there were no immediately available events, but the\n            // response will block until either new events are available or the\n            // request times out. In both cases we should should try to read events\n            // immediately again\n\n            lock.release();\n\n            const notifyTimeoutHeader = res.headers.get(\n              EVENTS_NOTIFY_TIMEOUT_HEADER,\n            );\n\n            // Add 1s to the timeout to allow the server to potentially timeout first\n            const notifyTimeoutMs =\n              notifyTimeoutHeader && !isNaN(parseInt(notifyTimeoutHeader, 10))\n                ? Number(notifyTimeoutHeader) + 1_000\n                : null;\n\n            await Promise.race(\n              [\n                // We don't actually expect any response body here, but waiting for\n                // an empty body to be returned has been more reliable that waiting\n                // for the response body stream to close.\n                res.text(),\n                notifyTimeoutMs\n                  ? new Promise(resolve => setTimeout(resolve, notifyTimeoutMs))\n                  : null,\n              ].filter(Boolean),\n            );\n          } else if (res.status === 200) {\n            const data = await res.json();\n            if (data) {\n              for (const event of data.events ?? []) {\n                try {\n                  await onEvent({\n                    topic: event.topic,\n                    eventPayload: event.payload,\n                  });\n                } catch (error) {\n                  this.logger.warn(\n                    `Subscriber \"${subscriptionId}\" failed to process event for topic \"${event.topic}\"`,\n                    error,\n                  );\n                }\n              }\n            }\n          } else {\n            if (res.status === 404) {\n              this.logger.info(\n                `Polling event subscription resulted in a 404, recreating subscription`,\n              );\n              hasSubscription = false;\n            } else {\n              throw await ResponseError.fromResponse(res);\n            }\n          }\n        }\n\n        // If we haven't yet created the subscription, or if it was removed, create a new one\n        if (!hasSubscription) {\n          const res = await client.putSubscription(\n            {\n              path: { subscriptionId },\n              body: { topics },\n            },\n            { token },\n          );\n          hasSubscription = true;\n          if (!res.ok) {\n            if (res.status === 404 && this.mode !== 'always') {\n              this.logger.warn(\n                `Event subscribe request failed with status 404, events backend not found. Will only receive events that were sent locally on this process.`,\n              );\n              // Events backend is not present and not configured to always be used, bail out and stop polling\n              delete this.client;\n              return;\n            }\n            throw await ResponseError.fromResponse(res);\n          }\n        }\n\n        // No errors, reset backoff\n        backoffMs = POLL_BACKOFF_START_MS;\n\n        process.nextTick(poll);\n      } catch (error) {\n        this.logger.warn(\n          `Poll failed for subscription \"${subscriptionId}\", retrying in ${backoffMs.toFixed(\n            0,\n          )}ms`,\n          error,\n        );\n        setTimeout(poll, backoffMs);\n        backoffMs = Math.min(\n          backoffMs * POLL_BACKOFF_FACTOR,\n          POLL_BACKOFF_MAX_MS,\n        );\n      } finally {\n        lock.release();\n      }\n    };\n    poll();\n  }\n\n  async #getToken() {\n    if (!this.auth) {\n      throw new Error('Auth service not available');\n    }\n\n    try {\n      const { token } = await this.auth.getPluginRequestToken({\n        onBehalfOf: await this.auth.getOwnServiceCredentials(),\n        targetPluginId: 'events',\n      });\n      return token;\n    } catch (error) {\n      // This is a bit hacky, but handles the case where new auth is used\n      // without legacy auth fallback, and the events backend is not installed\n      if (\n        String(error).includes('Unable to generate legacy token') &&\n        this.mode !== 'always'\n      ) {\n        this.logger.warn(\n          `The events backend is not available and neither is legacy auth. Future events will not be persisted.`,\n        );\n        delete this.client;\n        return undefined;\n      }\n      throw error;\n    }\n  }\n\n  async shutdown() {\n    this.#isShuttingDown = true;\n    await Promise.all(this.#shutdownLocks);\n  }\n\n  #isShuttingDown = false;\n  #shutdownLocks = new Set<Promise<void>>();\n\n  // This locking mechanism helps ensure that we are either idle or waiting for\n  // a blocked events call before shutting down. It increases out changes of\n  // never dropping any events on shutdown.\n  #getShutdownLock(): { release(): void } | undefined {\n    if (this.#isShuttingDown) {\n      return undefined;\n    }\n\n    let release: () => void;\n\n    const lock = new Promise<void>(resolve => {\n      release = () => {\n        resolve();\n        this.#shutdownLocks.delete(lock);\n      };\n    });\n    this.#shutdownLocks.add(lock);\n    return { release: release! };\n  }\n}\n\n/**\n * In-process event broker which will pass the event to all registered subscribers\n * interested in it.\n * Events will not be persisted in any form.\n * Events will not be passed to subscribers at other instances of the same cluster.\n *\n * @public\n */\n// TODO(pjungermann): add opentelemetry? (see plugins/catalog-backend/src/util/opentelemetry.ts, etc.)\nexport class DefaultEventsService implements EventsService {\n  private constructor(\n    private readonly logger: LoggerService,\n    private readonly localBus: LocalEventBus,\n    private readonly mode: EventBusMode,\n  ) {}\n\n  static create(options: {\n    logger: LoggerService;\n    config?: RootConfigService;\n    useEventBus?: EventBusMode;\n  }): DefaultEventsService {\n    const eventBusMode =\n      options.useEventBus ??\n      ((options.config?.getOptionalString('events.useEventBus') ??\n        'auto') as EventBusMode);\n    if (!EVENT_BUS_MODES.includes(eventBusMode)) {\n      throw new Error(\n        `Invalid events.useEventBus config, must be one of ${EVENT_BUS_MODES.join(\n          ', ',\n        )}, got '${eventBusMode}'`,\n      );\n    }\n\n    return new DefaultEventsService(\n      options.logger,\n      new LocalEventBus(options.logger),\n      eventBusMode,\n    );\n  }\n\n  /**\n   * Returns a plugin-scoped context of the `EventService`\n   * that ensures to prefix subscriber IDs with the plugin ID.\n   *\n   * @param pluginId - The plugin that the `EventService` should be created for.\n   */\n  forPlugin(\n    pluginId: string,\n    options?: {\n      discovery: DiscoveryService;\n      logger: LoggerService;\n      auth: AuthService;\n      lifecycle: LifecycleService;\n    },\n  ): EventsService {\n    const client =\n      options && this.mode !== 'never'\n        ? new DefaultApiClient({\n            discoveryApi: options.discovery,\n            fetchApi: { fetch }, // use native node fetch\n          })\n        : undefined;\n    const logger = options?.logger ?? this.logger;\n    const service = new PluginEventsService(\n      pluginId,\n      this.localBus,\n      logger,\n      this.mode,\n      client,\n      options?.auth,\n    );\n    options?.lifecycle.addShutdownHook(async () => {\n      await service.shutdown();\n    });\n    return service;\n  }\n\n  async publish(params: EventParams): Promise<void> {\n    await this.localBus.publish(params);\n  }\n\n  async subscribe(options: EventsServiceSubscribeOptions): Promise<void> {\n    this.localBus.subscribe(options);\n  }\n}\n"],"names":["ResponseError","EVENTS_NOTIFY_TIMEOUT_HEADER","DefaultApiClient"],"mappings":";;;;;;AAgCA,MAAM,qBAAwB,GAAA,GAAA;AAC9B,MAAM,mBAAsB,GAAA,GAAA;AAC5B,MAAM,mBAAsB,GAAA,CAAA;AAE5B,MAAM,eAAkB,GAAA,CAAC,OAAS,EAAA,QAAA,EAAU,MAAM,CAAA;AAiB3C,MAAM,aAAc,CAAA;AAAA,EAChB,OAAA;AAAA,EAEA,YAAA,uBAAmB,GAG1B,EAAA;AAAA,EAEF,YAAY,MAAuB,EAAA;AACjC,IAAA,IAAA,CAAK,OAAU,GAAA,MAAA;AAAA;AACjB,EAEA,MAAM,QACJ,MAC4C,EAAA;AAC5C,IAAA,IAAA,CAAK,OAAQ,CAAA,KAAA;AAAA,MACX,CAAyB,sBAAA,EAAA,MAAA,CAAO,KAAK,CAAA,WAAA,EAAc,IAAK,CAAA,SAAA;AAAA,QACtD,MAAO,CAAA;AAAA,OACR,CAAa,UAAA,EAAA,IAAA,CAAK,SAAU,CAAA,MAAA,CAAO,YAAY,CAAC,CAAA;AAAA,KACnD;AAEA,IAAA,IAAI,CAAC,IAAK,CAAA,YAAA,CAAa,GAAI,CAAA,MAAA,CAAO,KAAK,CAAG,EAAA;AACxC,MAAO,OAAA,EAAE,mBAAqB,EAAA,EAAG,EAAA;AAAA;AAGnC,IAAA,MAAM,kBAAqC,EAAC;AAC5C,IAAA,IAAA,CAAK,aAAa,GAAI,CAAA,MAAA,CAAO,KAAK,CAAA,EAAG,QAAQ,CAAgB,YAAA,KAAA;AAC3D,MAAgB,eAAA,CAAA,IAAA;AAAA,QAAA,CACb,YAAY;AACX,UAAI,IAAA;AACF,YAAM,MAAA,YAAA,CAAa,QAAQ,MAAM,CAAA;AAAA,mBAC1B,KAAO,EAAA;AACd,YAAA,IAAA,CAAK,OAAQ,CAAA,IAAA;AAAA,cACX,CAAe,YAAA,EAAA,YAAA,CAAa,EAAE,CAAA,qCAAA,EAAwC,OAAO,KAAK,CAAA,CAAA,CAAA;AAAA,cAClF;AAAA,aACF;AAAA;AAEF,UAAA,OAAO,YAAa,CAAA,EAAA;AAAA,SACnB;AAAA,OACL;AAAA,KACD,CAAA;AAED,IAAA,OAAO,EAAE,mBAAqB,EAAA,MAAM,OAAQ,CAAA,GAAA,CAAI,eAAe,CAAE,EAAA;AAAA;AACnE,EAEA,MAAM,UAAU,OAAuD,EAAA;AACrE,IAAQ,OAAA,CAAA,MAAA,CAAO,QAAQ,CAAS,KAAA,KAAA;AAC9B,MAAA,IAAI,CAAC,IAAA,CAAK,YAAa,CAAA,GAAA,CAAI,KAAK,CAAG,EAAA;AACjC,QAAA,IAAA,CAAK,YAAa,CAAA,GAAA,CAAI,KAAO,EAAA,EAAE,CAAA;AAAA;AAGjC,MAAA,IAAA,CAAK,YAAa,CAAA,GAAA,CAAI,KAAK,CAAA,CAAG,IAAK,CAAA;AAAA,QACjC,IAAI,OAAQ,CAAA,EAAA;AAAA,QACZ,SAAS,OAAQ,CAAA;AAAA,OAClB,CAAA;AAAA,KACF,CAAA;AAAA;AAEL;AAMA,MAAM,mBAA6C,CAAA;AAAA,EACjD,YACmB,QACA,EAAA,QAAA,EACA,MACA,EAAA,IAAA,EACT,QACS,IACjB,EAAA;AANiB,IAAA,IAAA,CAAA,QAAA,GAAA,QAAA;AACA,IAAA,IAAA,CAAA,QAAA,GAAA,QAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA;AACT,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACS,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA;AAAA;AAChB,EAEH,MAAM,QAAQ,MAAoC,EAAA;AAChD,IAAM,MAAA,IAAA,GAAO,KAAK,gBAAiB,EAAA;AACnC,IAAA,IAAI,CAAC,IAAM,EAAA;AACT,MAAM,MAAA,IAAI,MAAM,0BAA0B,CAAA;AAAA;AAE5C,IAAI,IAAA;AACF,MAAA,MAAM,EAAE,mBAAoB,EAAA,GAAI,MAAM,IAAK,CAAA,QAAA,CAAS,QAAQ,MAAM,CAAA;AAElE,MAAA,MAAM,SAAS,IAAK,CAAA,MAAA;AACpB,MAAA,IAAI,CAAC,MAAQ,EAAA;AACX,QAAA;AAAA;AAEF,MAAM,MAAA,KAAA,GAAQ,MAAM,IAAA,CAAK,SAAU,EAAA;AACnC,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAA;AAAA;AAEF,MAAM,MAAA,GAAA,GAAM,MAAM,MAAO,CAAA,SAAA;AAAA,QACvB;AAAA,UACE,IAAM,EAAA;AAAA,YACJ,OAAO,EAAE,OAAA,EAAS,OAAO,YAAc,EAAA,KAAA,EAAO,OAAO,KAAM,EAAA;AAAA,YAC3D;AAAA;AACF,SACF;AAAA,QACA,EAAE,KAAM;AAAA,OACV;AAEA,MAAI,IAAA,CAAC,IAAI,EAAI,EAAA;AACX,QAAA,IAAI,GAAI,CAAA,MAAA,KAAW,GAAO,IAAA,IAAA,CAAK,SAAS,QAAU,EAAA;AAChD,UAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,YACV,CAAA,4GAAA;AAAA,WACF;AACA,UAAA,OAAO,IAAK,CAAA,MAAA;AACZ,UAAA;AAAA;AAEF,QAAM,MAAA,MAAMA,oBAAc,CAAA,YAAA,CAAa,GAAG,CAAA;AAAA;AAC5C,KACA,SAAA;AACA,MAAA,IAAA,CAAK,OAAQ,EAAA;AAAA;AACf;AACF,EAEA,MAAM,UAAU,OAAuD,EAAA;AACrE,IAAA,MAAM,iBAAiB,CAAG,EAAA,IAAA,CAAK,QAAQ,CAAA,CAAA,EAAI,QAAQ,EAAE,CAAA,CAAA;AAErD,IAAM,MAAA,IAAA,CAAK,SAAS,SAAU,CAAA;AAAA,MAC5B,EAAI,EAAA,cAAA;AAAA,MACJ,QAAQ,OAAQ,CAAA,MAAA;AAAA,MAChB,SAAS,OAAQ,CAAA;AAAA,KAClB,CAAA;AAED,IAAI,IAAA,CAAC,KAAK,MAAQ,EAAA;AAChB,MAAA;AAAA;AAGF,IAAA,IAAA,CAAK,aAAc,CAAA,cAAA,EAAgB,OAAQ,CAAA,MAAA,EAAQ,QAAQ,OAAO,CAAA;AAAA;AACpE,EAEA,aAAA,CACE,cACA,EAAA,MAAA,EACA,OACA,EAAA;AACA,IAAA,IAAI,eAAkB,GAAA,KAAA;AACtB,IAAA,IAAI,SAAY,GAAA,qBAAA;AAChB,IAAA,MAAM,OAAO,YAAY;AACvB,MAAA,MAAM,SAAS,IAAK,CAAA,MAAA;AACpB,MAAA,IAAI,CAAC,MAAQ,EAAA;AACX,QAAA;AAAA;AAEF,MAAM,MAAA,IAAA,GAAO,KAAK,gBAAiB,EAAA;AACnC,MAAA,IAAI,CAAC,IAAM,EAAA;AACT,QAAA;AAAA;AAEF,MAAI,IAAA;AACF,QAAM,MAAA,KAAA,GAAQ,MAAM,IAAA,CAAK,SAAU,EAAA;AACnC,QAAA,IAAI,CAAC,KAAO,EAAA;AACV,UAAA;AAAA;AAGF,QAAA,IAAI,eAAiB,EAAA;AACnB,UAAM,MAAA,GAAA,GAAM,MAAM,MAAO,CAAA,qBAAA;AAAA,YACvB;AAAA,cACE,IAAA,EAAM,EAAE,cAAe;AAAA,aACzB;AAAA,YACA,EAAE,KAAM;AAAA,WACV;AAEA,UAAI,IAAA,GAAA,CAAI,WAAW,GAAK,EAAA;AAMtB,YAAA,IAAA,CAAK,OAAQ,EAAA;AAEb,YAAM,MAAA,mBAAA,GAAsB,IAAI,OAAQ,CAAA,GAAA;AAAA,cACtCC;AAAA,aACF;AAGA,YAAA,MAAM,eACJ,GAAA,mBAAA,IAAuB,CAAC,KAAA,CAAM,QAAS,CAAA,mBAAA,EAAqB,EAAE,CAAC,CAC3D,GAAA,MAAA,CAAO,mBAAmB,CAAA,GAAI,GAC9B,GAAA,IAAA;AAEN,YAAA,MAAM,OAAQ,CAAA,IAAA;AAAA,cACZ;AAAA;AAAA;AAAA;AAAA,gBAIE,IAAI,IAAK,EAAA;AAAA,gBACT,eAAA,GACI,IAAI,OAAQ,CAAA,CAAA,OAAA,KAAW,WAAW,OAAS,EAAA,eAAe,CAAC,CAC3D,GAAA;AAAA,eACN,CAAE,OAAO,OAAO;AAAA,aAClB;AAAA,WACF,MAAA,IAAW,GAAI,CAAA,MAAA,KAAW,GAAK,EAAA;AAC7B,YAAM,MAAA,IAAA,GAAO,MAAM,GAAA,CAAI,IAAK,EAAA;AAC5B,YAAA,IAAI,IAAM,EAAA;AACR,cAAA,KAAA,MAAW,KAAS,IAAA,IAAA,CAAK,MAAU,IAAA,EAAI,EAAA;AACrC,gBAAI,IAAA;AACF,kBAAA,MAAM,OAAQ,CAAA;AAAA,oBACZ,OAAO,KAAM,CAAA,KAAA;AAAA,oBACb,cAAc,KAAM,CAAA;AAAA,mBACrB,CAAA;AAAA,yBACM,KAAO,EAAA;AACd,kBAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,oBACV,CAAe,YAAA,EAAA,cAAc,CAAwC,qCAAA,EAAA,KAAA,CAAM,KAAK,CAAA,CAAA,CAAA;AAAA,oBAChF;AAAA,mBACF;AAAA;AACF;AACF;AACF,WACK,MAAA;AACL,YAAI,IAAA,GAAA,CAAI,WAAW,GAAK,EAAA;AACtB,cAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,gBACV,CAAA,qEAAA;AAAA,eACF;AACA,cAAkB,eAAA,GAAA,KAAA;AAAA,aACb,MAAA;AACL,cAAM,MAAA,MAAMD,oBAAc,CAAA,YAAA,CAAa,GAAG,CAAA;AAAA;AAC5C;AACF;AAIF,QAAA,IAAI,CAAC,eAAiB,EAAA;AACpB,UAAM,MAAA,GAAA,GAAM,MAAM,MAAO,CAAA,eAAA;AAAA,YACvB;AAAA,cACE,IAAA,EAAM,EAAE,cAAe,EAAA;AAAA,cACvB,IAAA,EAAM,EAAE,MAAO;AAAA,aACjB;AAAA,YACA,EAAE,KAAM;AAAA,WACV;AACA,UAAkB,eAAA,GAAA,IAAA;AAClB,UAAI,IAAA,CAAC,IAAI,EAAI,EAAA;AACX,YAAA,IAAI,GAAI,CAAA,MAAA,KAAW,GAAO,IAAA,IAAA,CAAK,SAAS,QAAU,EAAA;AAChD,cAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,gBACV,CAAA,0IAAA;AAAA,eACF;AAEA,cAAA,OAAO,IAAK,CAAA,MAAA;AACZ,cAAA;AAAA;AAEF,YAAM,MAAA,MAAMA,oBAAc,CAAA,YAAA,CAAa,GAAG,CAAA;AAAA;AAC5C;AAIF,QAAY,SAAA,GAAA,qBAAA;AAEZ,QAAA,OAAA,CAAQ,SAAS,IAAI,CAAA;AAAA,eACd,KAAO,EAAA;AACd,QAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,UACV,CAAA,8BAAA,EAAiC,cAAc,CAAA,eAAA,EAAkB,SAAU,CAAA,OAAA;AAAA,YACzE;AAAA,WACD,CAAA,EAAA,CAAA;AAAA,UACD;AAAA,SACF;AACA,QAAA,UAAA,CAAW,MAAM,SAAS,CAAA;AAC1B,QAAA,SAAA,GAAY,IAAK,CAAA,GAAA;AAAA,UACf,SAAY,GAAA,mBAAA;AAAA,UACZ;AAAA,SACF;AAAA,OACA,SAAA;AACA,QAAA,IAAA,CAAK,OAAQ,EAAA;AAAA;AACf,KACF;AACA,IAAK,IAAA,EAAA;AAAA;AACP,EAEA,MAAM,SAAY,GAAA;AAChB,IAAI,IAAA,CAAC,KAAK,IAAM,EAAA;AACd,MAAM,MAAA,IAAI,MAAM,4BAA4B,CAAA;AAAA;AAG9C,IAAI,IAAA;AACF,MAAA,MAAM,EAAE,KAAM,EAAA,GAAI,MAAM,IAAA,CAAK,KAAK,qBAAsB,CAAA;AAAA,QACtD,UAAY,EAAA,MAAM,IAAK,CAAA,IAAA,CAAK,wBAAyB,EAAA;AAAA,QACrD,cAAgB,EAAA;AAAA,OACjB,CAAA;AACD,MAAO,OAAA,KAAA;AAAA,aACA,KAAO,EAAA;AAGd,MACE,IAAA,MAAA,CAAO,KAAK,CAAE,CAAA,QAAA,CAAS,iCAAiC,CACxD,IAAA,IAAA,CAAK,SAAS,QACd,EAAA;AACA,QAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,UACV,CAAA,oGAAA;AAAA,SACF;AACA,QAAA,OAAO,IAAK,CAAA,MAAA;AACZ,QAAO,OAAA,KAAA,CAAA;AAAA;AAET,MAAM,MAAA,KAAA;AAAA;AACR;AACF,EAEA,MAAM,QAAW,GAAA;AACf,IAAA,IAAA,CAAK,eAAkB,GAAA,IAAA;AACvB,IAAM,MAAA,OAAA,CAAQ,GAAI,CAAA,IAAA,CAAK,cAAc,CAAA;AAAA;AACvC,EAEA,eAAkB,GAAA,KAAA;AAAA,EAClB,cAAA,uBAAqB,GAAmB,EAAA;AAAA;AAAA;AAAA;AAAA,EAKxC,gBAAoD,GAAA;AAClD,IAAA,IAAI,KAAK,eAAiB,EAAA;AACxB,MAAO,OAAA,KAAA,CAAA;AAAA;AAGT,IAAI,IAAA,OAAA;AAEJ,IAAM,MAAA,IAAA,GAAO,IAAI,OAAA,CAAc,CAAW,OAAA,KAAA;AACxC,MAAA,OAAA,GAAU,MAAM;AACd,QAAQ,OAAA,EAAA;AACR,QAAK,IAAA,CAAA,cAAA,CAAe,OAAO,IAAI,CAAA;AAAA,OACjC;AAAA,KACD,CAAA;AACD,IAAK,IAAA,CAAA,cAAA,CAAe,IAAI,IAAI,CAAA;AAC5B,IAAA,OAAO,EAAE,OAAkB,EAAA;AAAA;AAE/B;AAWO,MAAM,oBAA8C,CAAA;AAAA,EACjD,WAAA,CACW,MACA,EAAA,QAAA,EACA,IACjB,EAAA;AAHiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,QAAA,GAAA,QAAA;AACA,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA;AAAA;AAChB,EAEH,OAAO,OAAO,OAIW,EAAA;AACvB,IAAA,MAAM,eACJ,OAAQ,CAAA,WAAA,KACN,QAAQ,MAAQ,EAAA,iBAAA,CAAkB,oBAAoB,CACtD,IAAA,MAAA,CAAA;AACJ,IAAA,IAAI,CAAC,eAAA,CAAgB,QAAS,CAAA,YAAY,CAAG,EAAA;AAC3C,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,qDAAqD,eAAgB,CAAA,IAAA;AAAA,UACnE;AAAA,SACD,UAAU,YAAY,CAAA,CAAA;AAAA,OACzB;AAAA;AAGF,IAAA,OAAO,IAAI,oBAAA;AAAA,MACT,OAAQ,CAAA,MAAA;AAAA,MACR,IAAI,aAAc,CAAA,OAAA,CAAQ,MAAM,CAAA;AAAA,MAChC;AAAA,KACF;AAAA;AACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,SAAA,CACE,UACA,OAMe,EAAA;AACf,IAAA,MAAM,SACJ,OAAW,IAAA,IAAA,CAAK,IAAS,KAAA,OAAA,GACrB,IAAIE,kCAAiB,CAAA;AAAA,MACnB,cAAc,OAAQ,CAAA,SAAA;AAAA,MACtB,QAAA,EAAU,EAAE,KAAM;AAAA;AAAA,KACnB,CACD,GAAA,KAAA,CAAA;AACN,IAAM,MAAA,MAAA,GAAS,OAAS,EAAA,MAAA,IAAU,IAAK,CAAA,MAAA;AACvC,IAAA,MAAM,UAAU,IAAI,mBAAA;AAAA,MAClB,QAAA;AAAA,MACA,IAAK,CAAA,QAAA;AAAA,MACL,MAAA;AAAA,MACA,IAAK,CAAA,IAAA;AAAA,MACL,MAAA;AAAA,MACA,OAAS,EAAA;AAAA,KACX;AACA,IAAS,OAAA,EAAA,SAAA,CAAU,gBAAgB,YAAY;AAC7C,MAAA,MAAM,QAAQ,QAAS,EAAA;AAAA,KACxB,CAAA;AACD,IAAO,OAAA,OAAA;AAAA;AACT,EAEA,MAAM,QAAQ,MAAoC,EAAA;AAChD,IAAM,MAAA,IAAA,CAAK,QAAS,CAAA,OAAA,CAAQ,MAAM,CAAA;AAAA;AACpC,EAEA,MAAM,UAAU,OAAuD,EAAA;AACrE,IAAK,IAAA,CAAA,QAAA,CAAS,UAAU,OAAO,CAAA;AAAA;AAEnC;;;;;"}

package/dist/api/EventsService.cjs.js

@@ -0,0 +1,6 @@
+'use strict';
+
+const EVENTS_NOTIFY_TIMEOUT_HEADER = "backstage-events-notify-timeout";
+
+exports.EVENTS_NOTIFY_TIMEOUT_HEADER = EVENTS_NOTIFY_TIMEOUT_HEADER;
+//# sourceMappingURL=EventsService.cjs.js.map

package/dist/api/EventsService.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventsService.cjs.js","sources":["../../src/api/EventsService.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 { EventParams } from './EventParams';\n\n/**\n * Allows a decoupled and asynchronous communication between components.\n * Components can publish events for a given topic and\n * others can subscribe for future events for topics they are interested in.\n *\n * @public\n */\nexport interface EventsService {\n  /**\n   * Publishes an event for the topic.\n   *\n   * @param params - parameters for the to be published event.\n   */\n  publish(params: EventParams): Promise<void>;\n\n  /**\n   * Subscribes to one or more topics, registering an event handler for them.\n   *\n   * @param options - event subscription options.\n   */\n  subscribe(options: EventsServiceSubscribeOptions): Promise<void>;\n}\n\n/**\n * @public\n */\nexport type EventsServiceSubscribeOptions = {\n  /**\n   * Subscriber ID that is scoped to the calling plugin. Subscribers with the same ID will have events distributed between them.\n   */\n  id: string;\n  topics: string[];\n  onEvent: EventsServiceEventHandler;\n};\n\n/**\n * @public\n */\nexport type EventsServiceEventHandler = (params: EventParams) => Promise<void>;\n\n/**\n * @public\n */\nexport const EVENTS_NOTIFY_TIMEOUT_HEADER = 'backstage-events-notify-timeout';\n"],"names":[],"mappings":";;AA6DO,MAAM,4BAA+B,GAAA;;;;"}

package/dist/index.cjs.js

@@ -1,6 +1,7 @@
 'use strict';
 
 var EventRouter = require('./api/EventRouter.cjs.js');
+var EventsService = require('./api/EventsService.cjs.js');
 var DefaultEventsService = require('./api/DefaultEventsService.cjs.js');
 var SubTopicEventRouter = require('./api/SubTopicEventRouter.cjs.js');
 var service = require('./service.cjs.js');
@@ -8,6 +9,7 @@ var service = require('./service.cjs.js');
 
 
 exports.EventRouter = EventRouter.EventRouter;
+exports.EVENTS_NOTIFY_TIMEOUT_HEADER = EventsService.EVENTS_NOTIFY_TIMEOUT_HEADER;
 exports.DefaultEventsService = DefaultEventsService.DefaultEventsService;
 exports.SubTopicEventRouter = SubTopicEventRouter.SubTopicEventRouter;
 exports.eventsServiceFactory = service.eventsServiceFactory;

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -46,7 +46,7 @@ interface EventsService {
  */
 type EventsServiceSubscribeOptions = {
     /**
-     * Identifier for the subscription. E.g., used as part of log messages.
+     * Subscriber ID that is scoped to the calling plugin. Subscribers with the same ID will have events distributed between them.
      */
     id: string;
     topics: string[];
@@ -56,6 +56,10 @@ type EventsServiceSubscribeOptions = {
  * @public
  */
 type EventsServiceEventHandler = (params: EventParams) => Promise<void>;
+/**
+ * @public
+ */
+declare const EVENTS_NOTIFY_TIMEOUT_HEADER = "backstage-events-notify-timeout";
 
 /**
  * Subscribes to a topic and - depending on a set of conditions -
@@ -289,4 +293,4 @@ declare const eventsServiceRef: _backstage_backend_plugin_api.ServiceRef<EventsS
 /** @public */
 declare const eventsServiceFactory: _backstage_backend_plugin_api.ServiceFactory<EventsService, "plugin", "singleton">;
 
-export { DefaultEventsService, type EventBroker, type EventBusMode, type EventParams, type EventPublisher, EventRouter, type EventSubscriber, type EventsService, type EventsServiceEventHandler, type EventsServiceSubscribeOptions, type HttpPostIngressOptions, type RequestDetails, type RequestRejectionDetails, type RequestValidationContext, type RequestValidator, SubTopicEventRouter, eventsServiceFactory, eventsServiceRef };
+export { DefaultEventsService, EVENTS_NOTIFY_TIMEOUT_HEADER, type EventBroker, type EventBusMode, type EventParams, type EventPublisher, EventRouter, type EventSubscriber, type EventsService, type EventsServiceEventHandler, type EventsServiceSubscribeOptions, type HttpPostIngressOptions, type RequestDetails, type RequestRejectionDetails, type RequestValidationContext, type RequestValidator, SubTopicEventRouter, eventsServiceFactory, eventsServiceRef };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-events-node",
-  "version": "0.4.5",
+  "version": "0.4.6-next.1",
   "description": "The plugin-events-node module for @backstage/plugin-events-backend",
   "backstage": {
     "role": "node-library",
@@ -60,15 +60,15 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "^1.0.2",
-    "@backstage/errors": "^1.2.5",
-    "@backstage/types": "^1.2.0",
+    "@backstage/backend-plugin-api": "1.1.0-next.1",
+    "@backstage/errors": "1.2.5",
+    "@backstage/types": "1.2.0",
     "cross-fetch": "^4.0.0",
     "uri-template": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^1.1.0",
-    "@backstage/cli": "^0.29.0",
+    "@backstage/backend-test-utils": "1.2.0-next.1",
+    "@backstage/cli": "0.29.3-next.1",
     "msw": "^1.0.0"
   },
   "configSchema": "config.d.ts"