@backstage/backend-defaults 0.5.1-next.0 → 0.5.1-next.2

package/dist/entrypoints/cache/CacheManager.cjs.js

@@ -0,0 +1,147 @@
+'use strict';
+
+var Keyv = require('keyv');
+var CacheClient = require('./CacheClient.cjs.js');
+var types$1 = require('./types.cjs.js');
+var types = require('@backstage/types');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var Keyv__default = /*#__PURE__*/_interopDefaultCompat(Keyv);
+
+class CacheManager {
+  /**
+   * Keys represent supported `backend.cache.store` values, mapped to factories
+   * that return Keyv instances appropriate to the store.
+   */
+  storeFactories = {
+    redis: this.createRedisStoreFactory(),
+    memcache: this.createMemcacheStoreFactory(),
+    memory: this.createMemoryStoreFactory()
+  };
+  logger;
+  store;
+  connection;
+  useRedisSets;
+  errorHandler;
+  defaultTtl;
+  /**
+   * Creates a new {@link CacheManager} instance by reading from the `backend`
+   * config section, specifically the `.cache` key.
+   *
+   * @param config - The loaded application configuration.
+   */
+  static fromConfig(config, options = {}) {
+    const store = config.getOptionalString("backend.cache.store") || "memory";
+    const defaultTtlConfig = config.getOptional("backend.cache.defaultTtl");
+    const connectionString = config.getOptionalString("backend.cache.connection") || "";
+    const useRedisSets = config.getOptionalBoolean("backend.cache.useRedisSets") ?? true;
+    const logger = options.logger?.child({
+      type: "cacheManager"
+    });
+    let defaultTtl;
+    if (defaultTtlConfig !== void 0 && defaultTtlConfig !== null) {
+      if (typeof defaultTtlConfig === "number") {
+        defaultTtl = defaultTtlConfig;
+      } else if (typeof defaultTtlConfig === "object" && !Array.isArray(defaultTtlConfig)) {
+        defaultTtl = types.durationToMilliseconds(defaultTtlConfig);
+      } else {
+        throw new Error(
+          `Invalid configuration backend.cache.defaultTtl: ${defaultTtlConfig}, expected milliseconds number or HumanDuration object`
+        );
+      }
+    }
+    return new CacheManager(
+      store,
+      connectionString,
+      useRedisSets,
+      options.onError,
+      logger,
+      defaultTtl
+    );
+  }
+  /** @internal */
+  constructor(store, connectionString, useRedisSets, errorHandler, logger, defaultTtl) {
+    if (!this.storeFactories.hasOwnProperty(store)) {
+      throw new Error(`Unknown cache store: ${store}`);
+    }
+    this.logger = logger;
+    this.store = store;
+    this.connection = connectionString;
+    this.useRedisSets = useRedisSets;
+    this.errorHandler = errorHandler;
+    this.defaultTtl = defaultTtl;
+  }
+  /**
+   * Generates a PluginCacheManager for consumption by plugins.
+   *
+   * @param pluginId - The plugin that the cache manager should be created for.
+   *        Plugin names should be unique.
+   */
+  forPlugin(pluginId) {
+    const clientFactory = (options) => {
+      const ttl = options.defaultTtl ?? this.defaultTtl;
+      return this.getClientWithTtl(
+        pluginId,
+        ttl !== void 0 ? types$1.ttlToMilliseconds(ttl) : void 0
+      );
+    };
+    return new CacheClient.DefaultCacheClient(clientFactory({}), clientFactory, {});
+  }
+  getClientWithTtl(pluginId, ttl) {
+    return this.storeFactories[this.store](pluginId, ttl);
+  }
+  createRedisStoreFactory() {
+    const KeyvRedis = require("@keyv/redis");
+    let store;
+    return (pluginId, defaultTtl) => {
+      if (!store) {
+        store = new KeyvRedis(this.connection, {
+          useRedisSets: this.useRedisSets
+        });
+        store.on("error", (err) => {
+          this.logger?.error("Failed to create redis cache client", err);
+          this.errorHandler?.(err);
+        });
+      }
+      return new Keyv__default.default({
+        namespace: pluginId,
+        ttl: defaultTtl,
+        store,
+        emitErrors: false,
+        useRedisSets: this.useRedisSets
+      });
+    };
+  }
+  createMemcacheStoreFactory() {
+    const KeyvMemcache = require("@keyv/memcache");
+    let store;
+    return (pluginId, defaultTtl) => {
+      if (!store) {
+        store = new KeyvMemcache(this.connection);
+        store.on("error", (err) => {
+          this.logger?.error("Failed to create memcache cache client", err);
+          this.errorHandler?.(err);
+        });
+      }
+      return new Keyv__default.default({
+        namespace: pluginId,
+        ttl: defaultTtl,
+        emitErrors: false,
+        store
+      });
+    };
+  }
+  createMemoryStoreFactory() {
+    const store = /* @__PURE__ */ new Map();
+    return (pluginId, defaultTtl) => new Keyv__default.default({
+      namespace: pluginId,
+      ttl: defaultTtl,
+      emitErrors: false,
+      store
+    });
+  }
+}
+
+exports.CacheManager = CacheManager;
+//# sourceMappingURL=CacheManager.cjs.js.map

package/dist/entrypoints/cache/CacheManager.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CacheManager.cjs.js","sources":["../../../src/entrypoints/cache/CacheManager.ts"],"sourcesContent":["/*\n * Copyright 2021 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  CacheService,\n  CacheServiceOptions,\n  LoggerService,\n  RootConfigService,\n} from '@backstage/backend-plugin-api';\nimport Keyv from 'keyv';\nimport { DefaultCacheClient } from './CacheClient';\nimport { CacheManagerOptions, ttlToMilliseconds } from './types';\nimport { durationToMilliseconds } from '@backstage/types';\n\ntype StoreFactory = (pluginId: string, defaultTtl: number | undefined) => Keyv;\n\n/**\n * Implements a Cache Manager which will automatically create new cache clients\n * for plugins when requested. All requested cache clients are created with the\n * connection details provided.\n *\n * @public\n */\nexport class CacheManager {\n  /**\n   * Keys represent supported `backend.cache.store` values, mapped to factories\n   * that return Keyv instances appropriate to the store.\n   */\n  private readonly storeFactories = {\n    redis: this.createRedisStoreFactory(),\n    memcache: this.createMemcacheStoreFactory(),\n    memory: this.createMemoryStoreFactory(),\n  };\n\n  private readonly logger?: LoggerService;\n  private readonly store: keyof CacheManager['storeFactories'];\n  private readonly connection: string;\n  private readonly useRedisSets: boolean;\n  private readonly errorHandler: CacheManagerOptions['onError'];\n  private readonly defaultTtl?: number;\n\n  /**\n   * Creates a new {@link CacheManager} instance by reading from the `backend`\n   * config section, specifically the `.cache` key.\n   *\n   * @param config - The loaded application configuration.\n   */\n  static fromConfig(\n    config: RootConfigService,\n    options: CacheManagerOptions = {},\n  ): CacheManager {\n    // If no `backend.cache` config is provided, instantiate the CacheManager\n    // with an in-memory cache client.\n    const store = config.getOptionalString('backend.cache.store') || 'memory';\n    const defaultTtlConfig = config.getOptional('backend.cache.defaultTtl');\n    const connectionString =\n      config.getOptionalString('backend.cache.connection') || '';\n    const useRedisSets =\n      config.getOptionalBoolean('backend.cache.useRedisSets') ?? true;\n    const logger = options.logger?.child({\n      type: 'cacheManager',\n    });\n\n    let defaultTtl: number | undefined;\n    if (defaultTtlConfig !== undefined && defaultTtlConfig !== null) {\n      if (typeof defaultTtlConfig === 'number') {\n        defaultTtl = defaultTtlConfig;\n      } else if (\n        typeof defaultTtlConfig === 'object' &&\n        !Array.isArray(defaultTtlConfig)\n      ) {\n        defaultTtl = durationToMilliseconds(defaultTtlConfig);\n      } else {\n        throw new Error(\n          `Invalid configuration backend.cache.defaultTtl: ${defaultTtlConfig}, expected milliseconds number or HumanDuration object`,\n        );\n      }\n    }\n\n    return new CacheManager(\n      store,\n      connectionString,\n      useRedisSets,\n      options.onError,\n      logger,\n      defaultTtl,\n    );\n  }\n\n  /** @internal */\n  constructor(\n    store: string,\n    connectionString: string,\n    useRedisSets: boolean,\n    errorHandler: CacheManagerOptions['onError'],\n    logger?: LoggerService,\n    defaultTtl?: number,\n  ) {\n    if (!this.storeFactories.hasOwnProperty(store)) {\n      throw new Error(`Unknown cache store: ${store}`);\n    }\n    this.logger = logger;\n    this.store = store as keyof CacheManager['storeFactories'];\n    this.connection = connectionString;\n    this.useRedisSets = useRedisSets;\n    this.errorHandler = errorHandler;\n    this.defaultTtl = defaultTtl;\n  }\n\n  /**\n   * Generates a PluginCacheManager for consumption by plugins.\n   *\n   * @param pluginId - The plugin that the cache manager should be created for.\n   *        Plugin names should be unique.\n   */\n  forPlugin(pluginId: string): CacheService {\n    const clientFactory = (options: CacheServiceOptions) => {\n      const ttl = options.defaultTtl ?? this.defaultTtl;\n      return this.getClientWithTtl(\n        pluginId,\n        ttl !== undefined ? ttlToMilliseconds(ttl) : undefined,\n      );\n    };\n\n    return new DefaultCacheClient(clientFactory({}), clientFactory, {});\n  }\n\n  private getClientWithTtl(pluginId: string, ttl: number | undefined): Keyv {\n    return this.storeFactories[this.store](pluginId, ttl);\n  }\n\n  private createRedisStoreFactory(): StoreFactory {\n    const KeyvRedis = require('@keyv/redis');\n    let store: typeof KeyvRedis | undefined;\n    return (pluginId, defaultTtl) => {\n      if (!store) {\n        store = new KeyvRedis(this.connection, {\n          useRedisSets: this.useRedisSets,\n        });\n        // Always provide an error handler to avoid stopping the process\n        store.on('error', (err: Error) => {\n          this.logger?.error('Failed to create redis cache client', err);\n          this.errorHandler?.(err);\n        });\n      }\n      return new Keyv({\n        namespace: pluginId,\n        ttl: defaultTtl,\n        store,\n        emitErrors: false,\n        useRedisSets: this.useRedisSets,\n      });\n    };\n  }\n\n  private createMemcacheStoreFactory(): StoreFactory {\n    const KeyvMemcache = require('@keyv/memcache');\n    let store: typeof KeyvMemcache | undefined;\n    return (pluginId, defaultTtl) => {\n      if (!store) {\n        store = new KeyvMemcache(this.connection);\n        // Always provide an error handler to avoid stopping the process\n        store.on('error', (err: Error) => {\n          this.logger?.error('Failed to create memcache cache client', err);\n          this.errorHandler?.(err);\n        });\n      }\n      return new Keyv({\n        namespace: pluginId,\n        ttl: defaultTtl,\n        emitErrors: false,\n        store,\n      });\n    };\n  }\n\n  private createMemoryStoreFactory(): StoreFactory {\n    const store = new Map();\n    return (pluginId, defaultTtl) =>\n      new Keyv({\n        namespace: pluginId,\n        ttl: defaultTtl,\n        emitErrors: false,\n        store,\n      });\n  }\n}\n"],"names":["durationToMilliseconds","ttlToMilliseconds","DefaultCacheClient","Keyv"],"mappings":";;;;;;;;;;;AAoCO,MAAM,YAAa,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKP,cAAiB,GAAA;AAAA,IAChC,KAAA,EAAO,KAAK,uBAAwB,EAAA;AAAA,IACpC,QAAA,EAAU,KAAK,0BAA2B,EAAA;AAAA,IAC1C,MAAA,EAAQ,KAAK,wBAAyB,EAAA;AAAA,GACxC,CAAA;AAAA,EAEiB,MAAA,CAAA;AAAA,EACA,KAAA,CAAA;AAAA,EACA,UAAA,CAAA;AAAA,EACA,YAAA,CAAA;AAAA,EACA,YAAA,CAAA;AAAA,EACA,UAAA,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQjB,OAAO,UAAA,CACL,MACA,EAAA,OAAA,GAA+B,EACjB,EAAA;AAGd,IAAA,MAAM,KAAQ,GAAA,MAAA,CAAO,iBAAkB,CAAA,qBAAqB,CAAK,IAAA,QAAA,CAAA;AACjE,IAAM,MAAA,gBAAA,GAAmB,MAAO,CAAA,WAAA,CAAY,0BAA0B,CAAA,CAAA;AACtE,IAAA,MAAM,gBACJ,GAAA,MAAA,CAAO,iBAAkB,CAAA,0BAA0B,CAAK,IAAA,EAAA,CAAA;AAC1D,IAAA,MAAM,YACJ,GAAA,MAAA,CAAO,kBAAmB,CAAA,4BAA4B,CAAK,IAAA,IAAA,CAAA;AAC7D,IAAM,MAAA,MAAA,GAAS,OAAQ,CAAA,MAAA,EAAQ,KAAM,CAAA;AAAA,MACnC,IAAM,EAAA,cAAA;AAAA,KACP,CAAA,CAAA;AAED,IAAI,IAAA,UAAA,CAAA;AACJ,IAAI,IAAA,gBAAA,KAAqB,KAAa,CAAA,IAAA,gBAAA,KAAqB,IAAM,EAAA;AAC/D,MAAI,IAAA,OAAO,qBAAqB,QAAU,EAAA;AACxC,QAAa,UAAA,GAAA,gBAAA,CAAA;AAAA,OACf,MAAA,IACE,OAAO,gBAAqB,KAAA,QAAA,IAC5B,CAAC,KAAM,CAAA,OAAA,CAAQ,gBAAgB,CAC/B,EAAA;AACA,QAAA,UAAA,GAAaA,6BAAuB,gBAAgB,CAAA,CAAA;AAAA,OAC/C,MAAA;AACL,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,mDAAmD,gBAAgB,CAAA,sDAAA,CAAA;AAAA,SACrE,CAAA;AAAA,OACF;AAAA,KACF;AAEA,IAAA,OAAO,IAAI,YAAA;AAAA,MACT,KAAA;AAAA,MACA,gBAAA;AAAA,MACA,YAAA;AAAA,MACA,OAAQ,CAAA,OAAA;AAAA,MACR,MAAA;AAAA,MACA,UAAA;AAAA,KACF,CAAA;AAAA,GACF;AAAA;AAAA,EAGA,YACE,KACA,EAAA,gBAAA,EACA,YACA,EAAA,YAAA,EACA,QACA,UACA,EAAA;AACA,IAAA,IAAI,CAAC,IAAA,CAAK,cAAe,CAAA,cAAA,CAAe,KAAK,CAAG,EAAA;AAC9C,MAAA,MAAM,IAAI,KAAA,CAAM,CAAwB,qBAAA,EAAA,KAAK,CAAE,CAAA,CAAA,CAAA;AAAA,KACjD;AACA,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AACd,IAAA,IAAA,CAAK,KAAQ,GAAA,KAAA,CAAA;AACb,IAAA,IAAA,CAAK,UAAa,GAAA,gBAAA,CAAA;AAClB,IAAA,IAAA,CAAK,YAAe,GAAA,YAAA,CAAA;AACpB,IAAA,IAAA,CAAK,YAAe,GAAA,YAAA,CAAA;AACpB,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA,CAAA;AAAA,GACpB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,UAAU,QAAgC,EAAA;AACxC,IAAM,MAAA,aAAA,GAAgB,CAAC,OAAiC,KAAA;AACtD,MAAM,MAAA,GAAA,GAAM,OAAQ,CAAA,UAAA,IAAc,IAAK,CAAA,UAAA,CAAA;AACvC,MAAA,OAAO,IAAK,CAAA,gBAAA;AAAA,QACV,QAAA;AAAA,QACA,GAAQ,KAAA,KAAA,CAAA,GAAYC,yBAAkB,CAAA,GAAG,CAAI,GAAA,KAAA,CAAA;AAAA,OAC/C,CAAA;AAAA,KACF,CAAA;AAEA,IAAO,OAAA,IAAIC,+BAAmB,aAAc,CAAA,EAAE,CAAG,EAAA,aAAA,EAAe,EAAE,CAAA,CAAA;AAAA,GACpE;AAAA,EAEQ,gBAAA,CAAiB,UAAkB,GAA+B,EAAA;AACxE,IAAA,OAAO,KAAK,cAAe,CAAA,IAAA,CAAK,KAAK,CAAA,CAAE,UAAU,GAAG,CAAA,CAAA;AAAA,GACtD;AAAA,EAEQ,uBAAwC,GAAA;AAC9C,IAAM,MAAA,SAAA,GAAY,QAAQ,aAAa,CAAA,CAAA;AACvC,IAAI,IAAA,KAAA,CAAA;AACJ,IAAO,OAAA,CAAC,UAAU,UAAe,KAAA;AAC/B,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAQ,KAAA,GAAA,IAAI,SAAU,CAAA,IAAA,CAAK,UAAY,EAAA;AAAA,UACrC,cAAc,IAAK,CAAA,YAAA;AAAA,SACpB,CAAA,CAAA;AAED,QAAM,KAAA,CAAA,EAAA,CAAG,OAAS,EAAA,CAAC,GAAe,KAAA;AAChC,UAAK,IAAA,CAAA,MAAA,EAAQ,KAAM,CAAA,qCAAA,EAAuC,GAAG,CAAA,CAAA;AAC7D,UAAA,IAAA,CAAK,eAAe,GAAG,CAAA,CAAA;AAAA,SACxB,CAAA,CAAA;AAAA,OACH;AACA,MAAA,OAAO,IAAIC,qBAAK,CAAA;AAAA,QACd,SAAW,EAAA,QAAA;AAAA,QACX,GAAK,EAAA,UAAA;AAAA,QACL,KAAA;AAAA,QACA,UAAY,EAAA,KAAA;AAAA,QACZ,cAAc,IAAK,CAAA,YAAA;AAAA,OACpB,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAEQ,0BAA2C,GAAA;AACjD,IAAM,MAAA,YAAA,GAAe,QAAQ,gBAAgB,CAAA,CAAA;AAC7C,IAAI,IAAA,KAAA,CAAA;AACJ,IAAO,OAAA,CAAC,UAAU,UAAe,KAAA;AAC/B,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAQ,KAAA,GAAA,IAAI,YAAa,CAAA,IAAA,CAAK,UAAU,CAAA,CAAA;AAExC,QAAM,KAAA,CAAA,EAAA,CAAG,OAAS,EAAA,CAAC,GAAe,KAAA;AAChC,UAAK,IAAA,CAAA,MAAA,EAAQ,KAAM,CAAA,wCAAA,EAA0C,GAAG,CAAA,CAAA;AAChE,UAAA,IAAA,CAAK,eAAe,GAAG,CAAA,CAAA;AAAA,SACxB,CAAA,CAAA;AAAA,OACH;AACA,MAAA,OAAO,IAAIA,qBAAK,CAAA;AAAA,QACd,SAAW,EAAA,QAAA;AAAA,QACX,GAAK,EAAA,UAAA;AAAA,QACL,UAAY,EAAA,KAAA;AAAA,QACZ,KAAA;AAAA,OACD,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAEQ,wBAAyC,GAAA;AAC/C,IAAM,MAAA,KAAA,uBAAY,GAAI,EAAA,CAAA;AACtB,IAAA,OAAO,CAAC,QAAA,EAAU,UAChB,KAAA,IAAIA,qBAAK,CAAA;AAAA,MACP,SAAW,EAAA,QAAA;AAAA,MACX,GAAK,EAAA,UAAA;AAAA,MACL,UAAY,EAAA,KAAA;AAAA,MACZ,KAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACL;AACF;;;;"}

package/dist/entrypoints/cache/cacheServiceFactory.cjs.js

@@ -0,0 +1,22 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var CacheManager = require('./CacheManager.cjs.js');
+
+const cacheServiceFactory = backendPluginApi.createServiceFactory({
+  service: backendPluginApi.coreServices.cache,
+  deps: {
+    config: backendPluginApi.coreServices.rootConfig,
+    plugin: backendPluginApi.coreServices.pluginMetadata,
+    logger: backendPluginApi.coreServices.rootLogger
+  },
+  async createRootContext({ config, logger }) {
+    return CacheManager.CacheManager.fromConfig(config, { logger });
+  },
+  async factory({ plugin }, manager) {
+    return manager.forPlugin(plugin.getId());
+  }
+});
+
+exports.cacheServiceFactory = cacheServiceFactory;
+//# sourceMappingURL=cacheServiceFactory.cjs.js.map

package/dist/entrypoints/cache/cacheServiceFactory.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cacheServiceFactory.cjs.js","sources":["../../../src/entrypoints/cache/cacheServiceFactory.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  coreServices,\n  createServiceFactory,\n} from '@backstage/backend-plugin-api';\nimport { CacheManager } from './CacheManager';\n\n/**\n * Key-value store for caching data.\n *\n * See {@link @backstage/code-plugin-api#CacheService}\n * and {@link https://backstage.io/docs/backend-system/core-services/cache | the service docs}\n * for more information.\n *\n * @public\n */\nexport const cacheServiceFactory = createServiceFactory({\n  service: coreServices.cache,\n  deps: {\n    config: coreServices.rootConfig,\n    plugin: coreServices.pluginMetadata,\n    logger: coreServices.rootLogger,\n  },\n  async createRootContext({ config, logger }) {\n    return CacheManager.fromConfig(config, { logger });\n  },\n  async factory({ plugin }, manager) {\n    return manager.forPlugin(plugin.getId());\n  },\n});\n"],"names":["createServiceFactory","coreServices","CacheManager"],"mappings":";;;;;AA+BO,MAAM,sBAAsBA,qCAAqB,CAAA;AAAA,EACtD,SAASC,6BAAa,CAAA,KAAA;AAAA,EACtB,IAAM,EAAA;AAAA,IACJ,QAAQA,6BAAa,CAAA,UAAA;AAAA,IACrB,QAAQA,6BAAa,CAAA,cAAA;AAAA,IACrB,QAAQA,6BAAa,CAAA,UAAA;AAAA,GACvB;AAAA,EACA,MAAM,iBAAA,CAAkB,EAAE,MAAA,EAAQ,QAAU,EAAA;AAC1C,IAAA,OAAOC,yBAAa,CAAA,UAAA,CAAW,MAAQ,EAAA,EAAE,QAAQ,CAAA,CAAA;AAAA,GACnD;AAAA,EACA,MAAM,OAAA,CAAQ,EAAE,MAAA,IAAU,OAAS,EAAA;AACjC,IAAA,OAAO,OAAQ,CAAA,SAAA,CAAU,MAAO,CAAA,KAAA,EAAO,CAAA,CAAA;AAAA,GACzC;AACF,CAAC;;;;"}

package/dist/entrypoints/cache/types.cjs.js

@@ -0,0 +1,10 @@
+'use strict';
+
+var types = require('@backstage/types');
+
+function ttlToMilliseconds(ttl) {
+  return typeof ttl === "number" ? ttl : types.durationToMilliseconds(ttl);
+}
+
+exports.ttlToMilliseconds = ttlToMilliseconds;
+//# sourceMappingURL=types.cjs.js.map

package/dist/entrypoints/cache/types.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.cjs.js","sources":["../../../src/entrypoints/cache/types.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { LoggerService } from '@backstage/backend-plugin-api';\nimport { HumanDuration, durationToMilliseconds } from '@backstage/types';\n\n/**\n * Options given when constructing a {@link CacheManager}.\n *\n * @public\n */\nexport type CacheManagerOptions = {\n  /**\n   * An optional logger for use by the PluginCacheManager.\n   */\n  logger?: LoggerService;\n\n  /**\n   * An optional handler for connection errors emitted from the underlying data\n   * store.\n   */\n  onError?: (err: Error) => void;\n};\n\nexport function ttlToMilliseconds(ttl: number | HumanDuration): number {\n  return typeof ttl === 'number' ? ttl : durationToMilliseconds(ttl);\n}\n"],"names":["durationToMilliseconds"],"mappings":";;;;AAqCO,SAAS,kBAAkB,GAAqC,EAAA;AACrE,EAAA,OAAO,OAAO,GAAA,KAAQ,QAAW,GAAA,GAAA,GAAMA,6BAAuB,GAAG,CAAA,CAAA;AACnE;;;;"}

package/dist/entrypoints/database/DatabaseManager.cjs.js

@@ -0,0 +1,173 @@
+'use strict';
+
+var errors = require('@backstage/errors');
+var mysql = require('./connectors/mysql.cjs.js');
+var postgres = require('./connectors/postgres.cjs.js');
+var sqlite3 = require('./connectors/sqlite3.cjs.js');
+
+function pluginPath(pluginId) {
+  return `plugin.${pluginId}`;
+}
+class DatabaseManagerImpl {
+  constructor(config, connectors, options, databaseCache = /* @__PURE__ */ new Map(), keepaliveIntervals = /* @__PURE__ */ new Map()) {
+    this.config = config;
+    this.connectors = connectors;
+    this.options = options;
+    this.databaseCache = databaseCache;
+    this.keepaliveIntervals = keepaliveIntervals;
+    if (options?.rootLifecycle !== void 0) {
+      options.rootLifecycle.addShutdownHook(async () => {
+        await this.shutdown({ logger: options.rootLogger });
+      });
+    }
+  }
+  /**
+   * Generates a PluginDatabaseManager for consumption by plugins.
+   *
+   * @param pluginId - The plugin that the database manager should be created for. Plugin names
+   * should be unique as they are used to look up database config overrides under
+   * `backend.database.plugin`.
+   */
+  forPlugin(pluginId, deps) {
+    const client = this.getClientType(pluginId).client;
+    const connector = this.connectors[client];
+    if (!connector) {
+      throw new Error(
+        `Unsupported database client type '${client}' specified for plugin '${pluginId}'`
+      );
+    }
+    const getClient = () => this.getDatabase(pluginId, connector, deps);
+    const skip = this.options?.migrations?.skip ?? this.config.getOptionalBoolean(
+      `backend.database.plugin.${pluginId}.skipMigrations`
+    ) ?? this.config.getOptionalBoolean("backend.database.skipMigrations") ?? false;
+    return { getClient, migrations: { skip } };
+  }
+  /**
+   * Destroys all known connections.
+   */
+  async shutdown(deps) {
+    const pluginIds = Array.from(this.databaseCache.keys());
+    await Promise.allSettled(
+      pluginIds.map(async (pluginId) => {
+        clearInterval(this.keepaliveIntervals.get(pluginId));
+        const connection = await this.databaseCache.get(pluginId);
+        if (connection) {
+          await connection.destroy().catch((error) => {
+            deps?.logger?.error(
+              `Problem closing database connection for ${pluginId}: ${errors.stringifyError(
+                error
+              )}`
+            );
+          });
+        }
+      })
+    );
+  }
+  /**
+   * Provides the client type which should be used for a given plugin.
+   *
+   * The client type is determined by plugin specific config if present.
+   * Otherwise the base client is used as the fallback.
+   *
+   * @param pluginId - Plugin to get the client type for
+   * @returns Object with client type returned as `client` and boolean
+   *          representing whether or not the client was overridden as
+   *          `overridden`
+   */
+  getClientType(pluginId) {
+    const pluginClient = this.config.getOptionalString(
+      `${pluginPath(pluginId)}.client`
+    );
+    const baseClient = this.config.getString("client");
+    const client = pluginClient ?? baseClient;
+    return {
+      client,
+      overridden: client !== baseClient
+    };
+  }
+  /**
+   * Provides a scoped Knex client for a plugin as per application config.
+   *
+   * @param pluginId - Plugin to get a Knex client for
+   * @returns Promise which resolves to a scoped Knex database client for a
+   *          plugin
+   */
+  async getDatabase(pluginId, connector, deps) {
+    if (this.databaseCache.has(pluginId)) {
+      return this.databaseCache.get(pluginId);
+    }
+    const clientPromise = connector.getClient(pluginId, deps);
+    this.databaseCache.set(pluginId, clientPromise);
+    if (process.env.NODE_ENV !== "test") {
+      clientPromise.then(
+        (client) => this.startKeepaliveLoop(pluginId, client, deps.logger)
+      );
+    }
+    return clientPromise;
+  }
+  startKeepaliveLoop(pluginId, client, logger) {
+    let lastKeepaliveFailed = false;
+    this.keepaliveIntervals.set(
+      pluginId,
+      setInterval(() => {
+        client?.raw("select 1").then(
+          () => {
+            lastKeepaliveFailed = false;
+          },
+          (error) => {
+            if (!lastKeepaliveFailed) {
+              lastKeepaliveFailed = true;
+              logger.warn(
+                `Database keepalive failed for plugin ${pluginId}, ${errors.stringifyError(
+                  error
+                )}`
+              );
+            }
+          }
+        );
+      }, 60 * 1e3)
+    );
+  }
+}
+class DatabaseManager {
+  constructor(impl) {
+    this.impl = impl;
+  }
+  /**
+   * Creates a {@link DatabaseManager} from `backend.database` config.
+   *
+   * @param config - The loaded application configuration.
+   * @param options - An optional configuration object.
+   */
+  static fromConfig(config, options) {
+    const databaseConfig = config.getConfig("backend.database");
+    const prefix = databaseConfig.getOptionalString("prefix") || "backstage_plugin_";
+    return new DatabaseManager(
+      new DatabaseManagerImpl(
+        databaseConfig,
+        {
+          pg: new postgres.PgConnector(databaseConfig, prefix),
+          sqlite3: new sqlite3.Sqlite3Connector(databaseConfig),
+          "better-sqlite3": new sqlite3.Sqlite3Connector(databaseConfig),
+          mysql: new mysql.MysqlConnector(databaseConfig, prefix),
+          mysql2: new mysql.MysqlConnector(databaseConfig, prefix)
+        },
+        options
+      )
+    );
+  }
+  /**
+   * Generates a PluginDatabaseManager for consumption by plugins.
+   *
+   * @param pluginId - The plugin that the database manager should be created for. Plugin names
+   * should be unique as they are used to look up database config overrides under
+   * `backend.database.plugin`.
+   */
+  forPlugin(pluginId, deps) {
+    return this.impl.forPlugin(pluginId, deps);
+  }
+}
+
+exports.DatabaseManager = DatabaseManager;
+exports.DatabaseManagerImpl = DatabaseManagerImpl;
+//# sourceMappingURL=DatabaseManager.cjs.js.map

package/dist/entrypoints/database/DatabaseManager.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DatabaseManager.cjs.js","sources":["../../../src/entrypoints/database/DatabaseManager.ts"],"sourcesContent":["/*\n * Copyright 2021 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  LifecycleService,\n  LoggerService,\n  RootConfigService,\n  RootLifecycleService,\n  RootLoggerService,\n} from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\nimport { stringifyError } from '@backstage/errors';\nimport { Knex } from 'knex';\nimport { MysqlConnector } from './connectors/mysql';\nimport { PgConnector } from './connectors/postgres';\nimport { Sqlite3Connector } from './connectors/sqlite3';\nimport { Connector, PluginDatabaseManager } from './types';\n\n/**\n * Provides a config lookup path for a plugin's config block.\n */\nfunction pluginPath(pluginId: string): string {\n  return `plugin.${pluginId}`;\n}\n\n/**\n * Creation options for {@link DatabaseManager}.\n *\n * @public\n */\nexport type DatabaseManagerOptions = {\n  migrations?: DatabaseService['migrations'];\n  rootLogger?: RootLoggerService;\n  rootLifecycle?: RootLifecycleService;\n};\n\n/**\n * Testable implementation class for {@link DatabaseManager} below.\n */\nexport class DatabaseManagerImpl {\n  constructor(\n    private readonly config: Config,\n    private readonly connectors: Record<string, Connector>,\n    private readonly options?: DatabaseManagerOptions,\n    private readonly databaseCache: Map<string, Promise<Knex>> = new Map(),\n    private readonly keepaliveIntervals: Map<\n      string,\n      NodeJS.Timeout\n    > = new Map(),\n  ) {\n    // If a rootLifecycle service was provided, register a shutdown hook to\n    // clean up any database connections.\n    if (options?.rootLifecycle !== undefined) {\n      options.rootLifecycle.addShutdownHook(async () => {\n        await this.shutdown({ logger: options.rootLogger });\n      });\n    }\n  }\n\n  /**\n   * Generates a PluginDatabaseManager for consumption by plugins.\n   *\n   * @param pluginId - The plugin that the database manager should be created for. Plugin names\n   * should be unique as they are used to look up database config overrides under\n   * `backend.database.plugin`.\n   */\n  forPlugin(\n    pluginId: string,\n    deps: {\n      logger: LoggerService;\n      lifecycle: LifecycleService;\n    },\n  ): PluginDatabaseManager {\n    const client = this.getClientType(pluginId).client;\n    const connector = this.connectors[client];\n    if (!connector) {\n      throw new Error(\n        `Unsupported database client type '${client}' specified for plugin '${pluginId}'`,\n      );\n    }\n    const getClient = () => this.getDatabase(pluginId, connector, deps);\n\n    const skip =\n      this.options?.migrations?.skip ??\n      this.config.getOptionalBoolean(\n        `backend.database.plugin.${pluginId}.skipMigrations`,\n      ) ??\n      this.config.getOptionalBoolean('backend.database.skipMigrations') ??\n      false;\n\n    return { getClient, migrations: { skip } };\n  }\n\n  /**\n   * Destroys all known connections.\n   */\n  private async shutdown(deps?: { logger?: LoggerService }): Promise<void> {\n    const pluginIds = Array.from(this.databaseCache.keys());\n    await Promise.allSettled(\n      pluginIds.map(async pluginId => {\n        // We no longer need to keep connections alive.\n        clearInterval(this.keepaliveIntervals.get(pluginId));\n\n        const connection = await this.databaseCache.get(pluginId);\n        if (connection) {\n          await connection.destroy().catch((error: unknown) => {\n            deps?.logger?.error(\n              `Problem closing database connection for ${pluginId}: ${stringifyError(\n                error,\n              )}`,\n            );\n          });\n        }\n      }),\n    );\n  }\n\n  /**\n   * Provides the client type which should be used for a given plugin.\n   *\n   * The client type is determined by plugin specific config if present.\n   * Otherwise the base client is used as the fallback.\n   *\n   * @param pluginId - Plugin to get the client type for\n   * @returns Object with client type returned as `client` and boolean\n   *          representing whether or not the client was overridden as\n   *          `overridden`\n   */\n  private getClientType(pluginId: string): {\n    client: string;\n    overridden: boolean;\n  } {\n    const pluginClient = this.config.getOptionalString(\n      `${pluginPath(pluginId)}.client`,\n    );\n\n    const baseClient = this.config.getString('client');\n    const client = pluginClient ?? baseClient;\n    return {\n      client,\n      overridden: client !== baseClient,\n    };\n  }\n\n  /**\n   * Provides a scoped Knex client for a plugin as per application config.\n   *\n   * @param pluginId - Plugin to get a Knex client for\n   * @returns Promise which resolves to a scoped Knex database client for a\n   *          plugin\n   */\n  private async getDatabase(\n    pluginId: string,\n    connector: Connector,\n    deps: {\n      logger: LoggerService;\n      lifecycle: LifecycleService;\n    },\n  ): Promise<Knex> {\n    if (this.databaseCache.has(pluginId)) {\n      return this.databaseCache.get(pluginId)!;\n    }\n\n    const clientPromise = connector.getClient(pluginId, deps);\n    this.databaseCache.set(pluginId, clientPromise);\n\n    if (process.env.NODE_ENV !== 'test') {\n      clientPromise.then(client =>\n        this.startKeepaliveLoop(pluginId, client, deps.logger),\n      );\n    }\n\n    return clientPromise;\n  }\n\n  private startKeepaliveLoop(\n    pluginId: string,\n    client: Knex,\n    logger: LoggerService,\n  ): void {\n    let lastKeepaliveFailed = false;\n\n    this.keepaliveIntervals.set(\n      pluginId,\n      setInterval(() => {\n        // During testing it can happen that the environment is torn down and\n        // this client is `undefined`, but this interval is still run.\n        client?.raw('select 1').then(\n          () => {\n            lastKeepaliveFailed = false;\n          },\n          (error: unknown) => {\n            if (!lastKeepaliveFailed) {\n              lastKeepaliveFailed = true;\n              logger.warn(\n                `Database keepalive failed for plugin ${pluginId}, ${stringifyError(\n                  error,\n                )}`,\n              );\n            }\n          },\n        );\n      }, 60 * 1000),\n    );\n  }\n}\n\n// NOTE: This class looks odd but is kept around for API compatibility reasons\n/**\n * Manages database connections for Backstage backend plugins.\n *\n * @public\n * @remarks\n *\n * The database manager allows the user to set connection and client settings on\n * a per pluginId basis by defining a database config block under\n * `plugin.<pluginId>` in addition to top level defaults. Optionally, a user may\n * set `prefix` which is used to prefix generated database names if config is\n * not provided.\n */\nexport class DatabaseManager {\n  /**\n   * Creates a {@link DatabaseManager} from `backend.database` config.\n   *\n   * @param config - The loaded application configuration.\n   * @param options - An optional configuration object.\n   */\n  static fromConfig(\n    config: RootConfigService,\n    options?: DatabaseManagerOptions,\n  ): DatabaseManager {\n    const databaseConfig = config.getConfig('backend.database');\n    const prefix =\n      databaseConfig.getOptionalString('prefix') || 'backstage_plugin_';\n    return new DatabaseManager(\n      new DatabaseManagerImpl(\n        databaseConfig,\n        {\n          pg: new PgConnector(databaseConfig, prefix),\n          sqlite3: new Sqlite3Connector(databaseConfig),\n          'better-sqlite3': new Sqlite3Connector(databaseConfig),\n          mysql: new MysqlConnector(databaseConfig, prefix),\n          mysql2: new MysqlConnector(databaseConfig, prefix),\n        },\n        options,\n      ),\n    );\n  }\n\n  private constructor(private readonly impl: DatabaseManagerImpl) {}\n\n  /**\n   * Generates a PluginDatabaseManager for consumption by plugins.\n   *\n   * @param pluginId - The plugin that the database manager should be created for. Plugin names\n   * should be unique as they are used to look up database config overrides under\n   * `backend.database.plugin`.\n   */\n  forPlugin(\n    pluginId: string,\n    deps: {\n      logger: LoggerService;\n      lifecycle: LifecycleService;\n    },\n  ): PluginDatabaseManager {\n    return this.impl.forPlugin(pluginId, deps);\n  }\n}\n"],"names":["stringifyError","PgConnector","Sqlite3Connector","MysqlConnector"],"mappings":";;;;;;;AAmCA,SAAS,WAAW,QAA0B,EAAA;AAC5C,EAAA,OAAO,UAAU,QAAQ,CAAA,CAAA,CAAA;AAC3B,CAAA;AAgBO,MAAM,mBAAoB,CAAA;AAAA,EAC/B,WAAA,CACmB,MACA,EAAA,UAAA,EACA,OACA,EAAA,aAAA,mBAAgD,IAAA,GAAA,EAChD,EAAA,kBAAA,mBAGT,IAAA,GAAA,EACR,EAAA;AARiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA,CAAA;AACA,IAAA,IAAA,CAAA,UAAA,GAAA,UAAA,CAAA;AACA,IAAA,IAAA,CAAA,OAAA,GAAA,OAAA,CAAA;AACA,IAAA,IAAA,CAAA,aAAA,GAAA,aAAA,CAAA;AACA,IAAA,IAAA,CAAA,kBAAA,GAAA,kBAAA,CAAA;AAOjB,IAAI,IAAA,OAAA,EAAS,kBAAkB,KAAW,CAAA,EAAA;AACxC,MAAQ,OAAA,CAAA,aAAA,CAAc,gBAAgB,YAAY;AAChD,QAAA,MAAM,KAAK,QAAS,CAAA,EAAE,MAAQ,EAAA,OAAA,CAAQ,YAAY,CAAA,CAAA;AAAA,OACnD,CAAA,CAAA;AAAA,KACH;AAAA,GACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,SAAA,CACE,UACA,IAIuB,EAAA;AACvB,IAAA,MAAM,MAAS,GAAA,IAAA,CAAK,aAAc,CAAA,QAAQ,CAAE,CAAA,MAAA,CAAA;AAC5C,IAAM,MAAA,SAAA,GAAY,IAAK,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AACxC,IAAA,IAAI,CAAC,SAAW,EAAA;AACd,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,kCAAA,EAAqC,MAAM,CAAA,wBAAA,EAA2B,QAAQ,CAAA,CAAA,CAAA;AAAA,OAChF,CAAA;AAAA,KACF;AACA,IAAA,MAAM,YAAY,MAAM,IAAA,CAAK,WAAY,CAAA,QAAA,EAAU,WAAW,IAAI,CAAA,CAAA;AAElE,IAAA,MAAM,OACJ,IAAK,CAAA,OAAA,EAAS,UAAY,EAAA,IAAA,IAC1B,KAAK,MAAO,CAAA,kBAAA;AAAA,MACV,2BAA2B,QAAQ,CAAA,eAAA,CAAA;AAAA,KAErC,IAAA,IAAA,CAAK,MAAO,CAAA,kBAAA,CAAmB,iCAAiC,CAChE,IAAA,KAAA,CAAA;AAEF,IAAA,OAAO,EAAE,SAAA,EAAW,UAAY,EAAA,EAAE,MAAO,EAAA,CAAA;AAAA,GAC3C;AAAA;AAAA;AAAA;AAAA,EAKA,MAAc,SAAS,IAAkD,EAAA;AACvE,IAAA,MAAM,YAAY,KAAM,CAAA,IAAA,CAAK,IAAK,CAAA,aAAA,CAAc,MAAM,CAAA,CAAA;AACtD,IAAA,MAAM,OAAQ,CAAA,UAAA;AAAA,MACZ,SAAA,CAAU,GAAI,CAAA,OAAM,QAAY,KAAA;AAE9B,QAAA,aAAA,CAAc,IAAK,CAAA,kBAAA,CAAmB,GAAI,CAAA,QAAQ,CAAC,CAAA,CAAA;AAEnD,QAAA,MAAM,UAAa,GAAA,MAAM,IAAK,CAAA,aAAA,CAAc,IAAI,QAAQ,CAAA,CAAA;AACxD,QAAA,IAAI,UAAY,EAAA;AACd,UAAA,MAAM,UAAW,CAAA,OAAA,EAAU,CAAA,KAAA,CAAM,CAAC,KAAmB,KAAA;AACnD,YAAA,IAAA,EAAM,MAAQ,EAAA,KAAA;AAAA,cACZ,CAAA,wCAAA,EAA2C,QAAQ,CAAK,EAAA,EAAAA,qBAAA;AAAA,gBACtD,KAAA;AAAA,eACD,CAAA,CAAA;AAAA,aACH,CAAA;AAAA,WACD,CAAA,CAAA;AAAA,SACH;AAAA,OACD,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaQ,cAAc,QAGpB,EAAA;AACA,IAAM,MAAA,YAAA,GAAe,KAAK,MAAO,CAAA,iBAAA;AAAA,MAC/B,CAAA,EAAG,UAAW,CAAA,QAAQ,CAAC,CAAA,OAAA,CAAA;AAAA,KACzB,CAAA;AAEA,IAAA,MAAM,UAAa,GAAA,IAAA,CAAK,MAAO,CAAA,SAAA,CAAU,QAAQ,CAAA,CAAA;AACjD,IAAA,MAAM,SAAS,YAAgB,IAAA,UAAA,CAAA;AAC/B,IAAO,OAAA;AAAA,MACL,MAAA;AAAA,MACA,YAAY,MAAW,KAAA,UAAA;AAAA,KACzB,CAAA;AAAA,GACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAc,WAAA,CACZ,QACA,EAAA,SAAA,EACA,IAIe,EAAA;AACf,IAAA,IAAI,IAAK,CAAA,aAAA,CAAc,GAAI,CAAA,QAAQ,CAAG,EAAA;AACpC,MAAO,OAAA,IAAA,CAAK,aAAc,CAAA,GAAA,CAAI,QAAQ,CAAA,CAAA;AAAA,KACxC;AAEA,IAAA,MAAM,aAAgB,GAAA,SAAA,CAAU,SAAU,CAAA,QAAA,EAAU,IAAI,CAAA,CAAA;AACxD,IAAK,IAAA,CAAA,aAAA,CAAc,GAAI,CAAA,QAAA,EAAU,aAAa,CAAA,CAAA;AAE9C,IAAI,IAAA,OAAA,CAAQ,GAAI,CAAA,QAAA,KAAa,MAAQ,EAAA;AACnC,MAAc,aAAA,CAAA,IAAA;AAAA,QAAK,YACjB,IAAK,CAAA,kBAAA,CAAmB,QAAU,EAAA,MAAA,EAAQ,KAAK,MAAM,CAAA;AAAA,OACvD,CAAA;AAAA,KACF;AAEA,IAAO,OAAA,aAAA,CAAA;AAAA,GACT;AAAA,EAEQ,kBAAA,CACN,QACA,EAAA,MAAA,EACA,MACM,EAAA;AACN,IAAA,IAAI,mBAAsB,GAAA,KAAA,CAAA;AAE1B,IAAA,IAAA,CAAK,kBAAmB,CAAA,GAAA;AAAA,MACtB,QAAA;AAAA,MACA,YAAY,MAAM;AAGhB,QAAQ,MAAA,EAAA,GAAA,CAAI,UAAU,CAAE,CAAA,IAAA;AAAA,UACtB,MAAM;AACJ,YAAsB,mBAAA,GAAA,KAAA,CAAA;AAAA,WACxB;AAAA,UACA,CAAC,KAAmB,KAAA;AAClB,YAAA,IAAI,CAAC,mBAAqB,EAAA;AACxB,cAAsB,mBAAA,GAAA,IAAA,CAAA;AACtB,cAAO,MAAA,CAAA,IAAA;AAAA,gBACL,CAAA,qCAAA,EAAwC,QAAQ,CAAK,EAAA,EAAAA,qBAAA;AAAA,kBACnD,KAAA;AAAA,iBACD,CAAA,CAAA;AAAA,eACH,CAAA;AAAA,aACF;AAAA,WACF;AAAA,SACF,CAAA;AAAA,OACF,EAAG,KAAK,GAAI,CAAA;AAAA,KACd,CAAA;AAAA,GACF;AACF,CAAA;AAeO,MAAM,eAAgB,CAAA;AAAA,EA6BnB,YAA6B,IAA2B,EAAA;AAA3B,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA,CAAA;AAAA,GAA4B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAtBjE,OAAO,UACL,CAAA,MAAA,EACA,OACiB,EAAA;AACjB,IAAM,MAAA,cAAA,GAAiB,MAAO,CAAA,SAAA,CAAU,kBAAkB,CAAA,CAAA;AAC1D,IAAA,MAAM,MACJ,GAAA,cAAA,CAAe,iBAAkB,CAAA,QAAQ,CAAK,IAAA,mBAAA,CAAA;AAChD,IAAA,OAAO,IAAI,eAAA;AAAA,MACT,IAAI,mBAAA;AAAA,QACF,cAAA;AAAA,QACA;AAAA,UACE,EAAI,EAAA,IAAIC,oBAAY,CAAA,cAAA,EAAgB,MAAM,CAAA;AAAA,UAC1C,OAAA,EAAS,IAAIC,wBAAA,CAAiB,cAAc,CAAA;AAAA,UAC5C,gBAAA,EAAkB,IAAIA,wBAAA,CAAiB,cAAc,CAAA;AAAA,UACrD,KAAO,EAAA,IAAIC,oBAAe,CAAA,cAAA,EAAgB,MAAM,CAAA;AAAA,UAChD,MAAQ,EAAA,IAAIA,oBAAe,CAAA,cAAA,EAAgB,MAAM,CAAA;AAAA,SACnD;AAAA,QACA,OAAA;AAAA,OACF;AAAA,KACF,CAAA;AAAA,GACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,SAAA,CACE,UACA,IAIuB,EAAA;AACvB,IAAA,OAAO,IAAK,CAAA,IAAA,CAAK,SAAU,CAAA,QAAA,EAAU,IAAI,CAAA,CAAA;AAAA,GAC3C;AACF;;;;;"}

package/dist/entrypoints/database/connectors/defaultNameOverride.cjs.js

@@ -0,0 +1,14 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+function defaultNameOverride(name) {
+  return {
+    connection: {
+      database: name
+    }
+  };
+}
+
+exports.default = defaultNameOverride;
+//# sourceMappingURL=defaultNameOverride.cjs.js.map

package/dist/entrypoints/database/connectors/defaultNameOverride.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultNameOverride.cjs.js","sources":["../../../../src/entrypoints/database/connectors/defaultNameOverride.ts"],"sourcesContent":["/*\n * Copyright 2021 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 { Knex } from 'knex';\n\n/**\n * Provides a partial knex config with database name override.\n *\n * Default override for knex database drivers which accept ConnectionConfig\n * with `connection.database` as the database name field.\n *\n * @param name - database name to get config override for\n */\nexport default function defaultNameOverride(\n  name: string,\n): Partial<Knex.Config> {\n  return {\n    connection: {\n      database: name,\n    },\n  };\n}\n"],"names":[],"mappings":";;;;AA0BA,SAAwB,oBACtB,IACsB,EAAA;AACtB,EAAO,OAAA;AAAA,IACL,UAAY,EAAA;AAAA,MACV,QAAU,EAAA,IAAA;AAAA,KACZ;AAAA,GACF,CAAA;AACF;;;;"}

package/dist/entrypoints/database/connectors/defaultSchemaOverride.cjs.js

@@ -0,0 +1,12 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+function defaultSchemaOverride(name) {
+  return {
+    searchPath: [name]
+  };
+}
+
+exports.default = defaultSchemaOverride;
+//# sourceMappingURL=defaultSchemaOverride.cjs.js.map

package/dist/entrypoints/database/connectors/defaultSchemaOverride.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultSchemaOverride.cjs.js","sources":["../../../../src/entrypoints/database/connectors/defaultSchemaOverride.ts"],"sourcesContent":["/*\n * Copyright 2021 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 { Knex } from 'knex';\n\n/**\n * Provides a partial knex config with schema name override.\n *\n * @param name - schema name to get config override for\n */\nexport default function defaultSchemaOverride(\n  name: string,\n): Partial<Knex.Config> {\n  return {\n    searchPath: [name],\n  };\n}\n"],"names":[],"mappings":";;;;AAuBA,SAAwB,sBACtB,IACsB,EAAA;AACtB,EAAO,OAAA;AAAA,IACL,UAAA,EAAY,CAAC,IAAI,CAAA;AAAA,GACnB,CAAA;AACF;;;;"}

package/dist/entrypoints/database/connectors/mergeDatabaseConfig.cjs.js

@@ -0,0 +1,10 @@
+'use strict';
+
+var lodash = require('lodash');
+
+function mergeDatabaseConfig(config, ...overrides) {
+  return lodash.merge({}, config, ...overrides);
+}
+
+exports.mergeDatabaseConfig = mergeDatabaseConfig;
+//# sourceMappingURL=mergeDatabaseConfig.cjs.js.map

package/dist/entrypoints/database/connectors/mergeDatabaseConfig.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mergeDatabaseConfig.cjs.js","sources":["../../../../src/entrypoints/database/connectors/mergeDatabaseConfig.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { merge } from 'lodash';\n\n/**\n * Merges database objects together\n *\n * @public\n * @param config - The base config. The input is not modified\n * @param overrides - Any additional overrides\n */\nexport function mergeDatabaseConfig(config: any, ...overrides: any[]) {\n  return merge({}, config, ...overrides);\n}\n"],"names":["merge"],"mappings":";;;;AAyBgB,SAAA,mBAAA,CAAoB,WAAgB,SAAkB,EAAA;AACpE,EAAA,OAAOA,YAAM,CAAA,EAAI,EAAA,MAAA,EAAQ,GAAG,SAAS,CAAA,CAAA;AACvC;;;;"}