@backstage/backend-app-api 0.4.0-next.2 → 0.4.1-next.0

package/CHANGELOG.md

@@ -1,5 +1,55 @@
 # @backstage/backend-app-api
 
+## 0.4.1-next.0
+
+### Patch Changes
+
+- 928a12a9b3: Internal refactor of `/alpha` exports.
+- Updated dependencies
+  - @backstage/backend-tasks@0.4.4-next.0
+  - @backstage/backend-plugin-api@0.4.1-next.0
+  - @backstage/backend-common@0.18.3-next.0
+  - @backstage/cli-common@0.1.11
+  - @backstage/config@1.0.6
+  - @backstage/config-loader@1.1.8
+  - @backstage/errors@1.1.4
+  - @backstage/types@1.0.2
+  - @backstage/plugin-auth-node@0.2.12-next.0
+  - @backstage/plugin-permission-node@0.7.6-next.0
+
+## 0.4.0
+
+### Minor Changes
+
+- 01a075ec1d: **BREAKING**: Renamed `RootHttpRouterConfigureOptions` to `RootHttpRouterConfigureContext`, and removed the unused type `ServiceOrExtensionPoint`.
+- 4ae71b7f2e: **BREAKING** Renaming `*Factory` exports to `*ServiceFactory` instead. For example `configFactory` now is exported as `configServiceFactory`.
+- d31d8e00b3: **BREAKING** `HttpServerCertificateOptions` when specified with a `key` and `cert` should also have the `type: 'pem'` instead of `type: 'plain'`
+
+### Patch Changes
+
+- a18da2f8b5: Fixed an issue were the log redaction didn't properly escape RegExp characters.
+- 5febb216fe: Updated to match the new `CacheService` interface.
+- e716946103: Updated usage of the lifecycle service.
+- f60cca9da1: Updated database factory to pass service deps required for restoring database state during development.
+- 610d65e143: Updates to match new `BackendFeature` type.
+- 725383f69d: Tweaked messaging in the README.
+- b86efa2d04: Updated usage of `ServiceFactory`.
+- ab22515647: The shutdown signal handlers are now installed as part of the backend instance rather than the lifecycle service, and explicitly cause the process to exit.
+- b729f9f31f: Moved the options of the `config` and `rootHttpRouter` services out to the factories themselves, where they belong
+- ed8b5967d7: `HttpRouterFactoryOptions.getPath` is now optional as a default value is always provided in the factory.
+- 71a5ec0f06: Updated usages of `LogMeta`.
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.4.0
+  - @backstage/backend-common@0.18.2
+  - @backstage/backend-tasks@0.4.3
+  - @backstage/cli-common@0.1.11
+  - @backstage/config@1.0.6
+  - @backstage/config-loader@1.1.8
+  - @backstage/errors@1.1.4
+  - @backstage/types@1.0.2
+  - @backstage/plugin-auth-node@0.2.11
+  - @backstage/plugin-permission-node@0.7.5
+
 ## 0.4.0-next.2
 
 ### Minor Changes

package/README.md

@@ -1,6 +1,6 @@
 # @backstage/backend-app-api
 
-**This package is HIGHLY EXPERIMENTAL, do not use this for production**
+**This package is EXPERIMENTAL, we recommend against using it for production deployments**
 
 This package provides the core API used by Backstage backend apps.
 
@@ -17,3 +17,4 @@ yarn add --cwd packages/backend @backstage/backend-app-api
 
 - [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
 - [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md)
+- [Backstage Backend System](https://backstage.io/docs/backend-system/)

package/dist/index.cjs.js

@@ -1147,6 +1147,23 @@ var __privateMethod$1 = (obj, member, method) => {
   return method;
 };
 var _providedFactories, _loadedDefaultFactories, _implementations, _rootServiceImplementations, _resolveFactory, resolveFactory_fn, _checkForMissingDeps, checkForMissingDeps_fn;
+function toInternalServiceFactory(factory) {
+  const f = factory;
+  if (f.$$type !== "@backstage/ServiceFactory") {
+    throw new Error(`Invalid service factory, bad type '${f.$$type}'`);
+  }
+  if (f.version !== "v1") {
+    throw new Error(`Invalid service factory, bad version '${f.version}'`);
+  }
+  return f;
+}
+const pluginMetadataServiceFactory = backendPluginApi.createServiceFactory(
+  (options) => ({
+    service: backendPluginApi.coreServices.pluginMetadata,
+    deps: {},
+    factory: async () => ({ getId: () => options.pluginId })
+  })
+);
 class ServiceRegistry {
   constructor(factories) {
     __privateAdd$2(this, _resolveFactory);
@@ -1155,7 +1172,9 @@ class ServiceRegistry {
     __privateAdd$2(this, _loadedDefaultFactories, void 0);
     __privateAdd$2(this, _implementations, void 0);
     __privateAdd$2(this, _rootServiceImplementations, /* @__PURE__ */ new Map());
-    __privateSet$2(this, _providedFactories, new Map(factories.map((f) => [f.service.id, f])));
+    __privateSet$2(this, _providedFactories, new Map(
+      factories.map((sf) => [sf.service.id, toInternalServiceFactory(sf)])
+    ));
     __privateSet$2(this, _loadedDefaultFactories, /* @__PURE__ */ new Map());
     __privateSet$2(this, _implementations, /* @__PURE__ */ new Map());
   }
@@ -1165,7 +1184,7 @@ class ServiceRegistry {
   get(ref, pluginId) {
     var _a;
     return (_a = __privateMethod$1(this, _resolveFactory, resolveFactory_fn).call(this, ref, pluginId)) == null ? void 0 : _a.then((factory) => {
-      if (factory.scope === "root") {
+      if (factory.service.scope === "root") {
         let existing = __privateGet$2(this, _rootServiceImplementations).get(factory);
         if (!existing) {
           __privateMethod$1(this, _checkForMissingDeps, checkForMissingDeps_fn).call(this, factory, pluginId);
@@ -1180,7 +1199,7 @@ class ServiceRegistry {
             rootDeps.push(target.then((impl) => [name, impl]));
           }
           existing = Promise.all(rootDeps).then(
-            (entries) => factory.factory(Object.fromEntries(entries))
+            (entries) => factory.factory(Object.fromEntries(entries), void 0)
           );
           __privateGet$2(this, _rootServiceImplementations).set(factory, existing);
         }
@@ -1242,12 +1261,9 @@ _rootServiceImplementations = new WeakMap();
 _resolveFactory = new WeakSet();
 resolveFactory_fn = function(ref, pluginId) {
   if (ref.id === backendPluginApi.coreServices.pluginMetadata.id) {
-    return Promise.resolve({
-      scope: "plugin",
-      service: backendPluginApi.coreServices.pluginMetadata,
-      deps: {},
-      factory: async () => ({ getId: () => pluginId })
-    });
+    return Promise.resolve(
+      toInternalServiceFactory(pluginMetadataServiceFactory({ pluginId }))
+    );
   }
   let resolvedFactory = __privateGet$2(this, _providedFactories).get(ref.id);
   const { __defaultFactory: defaultFactory } = ref;
@@ -1258,7 +1274,7 @@ resolveFactory_fn = function(ref, pluginId) {
     let loadedFactory = __privateGet$2(this, _loadedDefaultFactories).get(defaultFactory);
     if (!loadedFactory) {
       loadedFactory = Promise.resolve().then(() => defaultFactory(ref)).then(
-        (f) => typeof f === "function" ? f() : f
+        (f) => toInternalServiceFactory(typeof f === "function" ? f() : f)
       );
       __privateGet$2(this, _loadedDefaultFactories).set(defaultFactory, loadedFactory);
     }
@@ -1365,7 +1381,7 @@ const cacheServiceFactory = backendPluginApi.createServiceFactory({
     return backendCommon.CacheManager.fromConfig(config);
   },
   async factory({ plugin }, manager) {
-    return manager.forPlugin(plugin.getId());
+    return manager.forPlugin(plugin.getId()).getClient();
   }
 });