@backstage/backend-app-api 0.7.9 → 0.8.0

package/CHANGELOG.md

@@ -1,51 +1,62 @@
 # @backstage/backend-app-api
 
-## 0.7.9
+## 0.8.0
+
+### Minor Changes
+
+- 1cb84d7: **BREAKING**: Removed the depreacted `getPath` option from `httpRouterServiceFactory`, as well as the `HttpRouterFactoryOptions` type.
+- f691c9b: **BREAKING**: Removed the ability to pass callback-form service factories through the `defaultServiceFactories` option of `createSpecializedBackend`. This is an immediate breaking change as usage of this function is expected to be very rare.
 
 ### Patch Changes
 
+- 2f99178: The `ServiceFactoryTest.get` method was deprecated and the `ServiceFactoryTest.getSubject` should be used instead. The `getSubject` method has the same behavior, but has a better method name to indicate that the service instance returned is the subject currently being tested.
+- b05e1e1: Service factories exported by this package have been updated to use the new service factory format that doesn't use a callback.
+- 617a7d2: Internal refactor that avoids the use of service factory options.
+- b60db08: Fixing exporting of classes properly from new packages
+- 18b96b1: The ability to install backend features in callback form (`() => BackendFeature`) has been deprecated. This typically means that you need to update the installed features to use the latest version of `@backstage/backend-plugin-api`. If the feature is from a third-party package, please reach out to the package maintainer to update it.
+- a63c4b6: Fixing issue with `MiddlewareFactory` deprecation wrapping
 - Updated dependencies
-  - @backstage/backend-plugin-api@0.6.21
-  - @backstage/backend-tasks@0.5.26
-  - @backstage/backend-common@0.23.2
-  - @backstage/plugin-auth-node@0.4.16
-  - @backstage/plugin-permission-node@0.7.32
+  - @backstage/backend-plugin-api@0.7.0
+  - @backstage/backend-common@0.23.3
+  - @backstage/cli-node@0.2.7
+  - @backstage/backend-tasks@0.5.27
+  - @backstage/plugin-permission-node@0.8.0
+  - @backstage/plugin-auth-node@0.4.17
+  - @backstage/config-loader@1.8.1
   - @backstage/cli-common@0.1.14
-  - @backstage/cli-node@0.2.6
   - @backstage/config@1.2.0
-  - @backstage/config-loader@1.8.1
   - @backstage/errors@1.2.4
   - @backstage/types@1.1.1
 
-## 0.7.8
+## 0.7.10-next.1
 
 ### Patch Changes
 
-- c5957b0: Fixing issue with `MiddlewareFactory` deprecation wrapping
 - Updated dependencies
-  - @backstage/backend-common@0.23.1
-  - @backstage/backend-plugin-api@0.6.20
-  - @backstage/backend-tasks@0.5.25
+  - @backstage/backend-common@0.23.3-next.1
+  - @backstage/backend-plugin-api@0.6.22-next.1
+  - @backstage/backend-tasks@0.5.27-next.1
   - @backstage/cli-common@0.1.14
   - @backstage/cli-node@0.2.6
   - @backstage/config@1.2.0
   - @backstage/config-loader@1.8.1
   - @backstage/errors@1.2.4
   - @backstage/types@1.1.1
-  - @backstage/plugin-auth-node@0.4.15
-  - @backstage/plugin-permission-node@0.7.31
+  - @backstage/plugin-auth-node@0.4.17-next.1
+  - @backstage/plugin-permission-node@0.7.33-next.1
 
-## 0.7.7
+## 0.7.9-next.0
 
 ### Patch Changes
 
-- d7cce61: Fixing exporting of classes properly from new packages
+- b60db08: Fixing exporting of classes properly from new packages
+- a63c4b6: Fixing issue with `MiddlewareFactory` deprecation wrapping
 - Updated dependencies
-  - @backstage/backend-common@0.23.1
-  - @backstage/backend-tasks@0.5.25
-  - @backstage/plugin-auth-node@0.4.15
-  - @backstage/plugin-permission-node@0.7.31
-  - @backstage/backend-plugin-api@0.6.20
+  - @backstage/backend-plugin-api@0.6.21-next.0
+  - @backstage/backend-common@0.23.2-next.0
+  - @backstage/backend-tasks@0.5.26-next.0
+  - @backstage/plugin-auth-node@0.4.16-next.0
+  - @backstage/plugin-permission-node@0.7.32-next.0
   - @backstage/cli-common@0.1.14
   - @backstage/cli-node@0.2.6
   - @backstage/config@1.2.0

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/backend-app-api__alpha",
-  "version": "0.7.9",
+  "version": "0.8.0",
   "main": "../dist/alpha.cjs.js",
   "types": "../dist/alpha.d.ts"
 }

package/dist/alpha.d.ts

@@ -2,6 +2,6 @@ import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
 import { FeatureDiscoveryService } from '@backstage/backend-plugin-api/alpha';
 
 /** @alpha */
-declare const featureDiscoveryServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<FeatureDiscoveryService, "root">;
+declare const featureDiscoveryServiceFactory: _backstage_backend_plugin_api.ServiceFactoryCompat<FeatureDiscoveryService, "root", undefined>;
 
 export { featureDiscoveryServiceFactory };

package/dist/index.cjs.js

@@ -1234,13 +1234,13 @@ function toInternalServiceFactory(factory) {
   }
   return f;
 }
-const pluginMetadataServiceFactory = backendPluginApi.createServiceFactory(
-  (options) => ({
+function createPluginMetadataServiceFactory(pluginId) {
+  return backendPluginApi.createServiceFactory({
     service: backendPluginApi.coreServices.pluginMetadata,
     deps: {},
-    factory: async () => ({ getId: () => options?.pluginId })
-  })
-);
+    factory: async () => ({ getId: () => pluginId })
+  });
+}
 class ServiceRegistry {
   static create(factories) {
     const registry = new ServiceRegistry(factories);
@@ -1263,7 +1263,7 @@ class ServiceRegistry {
   #resolveFactory(ref, pluginId) {
     if (ref.id === backendPluginApi.coreServices.pluginMetadata.id) {
       return Promise.resolve(
-        toInternalServiceFactory(pluginMetadataServiceFactory({ pluginId }))
+        toInternalServiceFactory(createPluginMetadataServiceFactory(pluginId))
       );
     }
     let resolvedFactory = this.#providedFactories.get(ref.id);
@@ -1783,12 +1783,9 @@ function unwrapFeature(feature) {
 }
 
 function createSpecializedBackend(options) {
-  const services = options.defaultServiceFactories.map(
-    (sf) => typeof sf === "function" ? sf() : sf
-  );
   const exists = /* @__PURE__ */ new Set();
   const duplicates = /* @__PURE__ */ new Set();
-  for (const { service } of services) {
+  for (const { service } of options.defaultServiceFactories) {
     if (exists.has(service.id)) {
       duplicates.add(service.id);
     } else {
@@ -1804,7 +1801,7 @@ function createSpecializedBackend(options) {
       `The ${backendPluginApi.coreServices.pluginMetadata.id} service cannot be overridden`
     );
   }
-  return new BackstageBackend(services);
+  return new BackstageBackend(options.defaultServiceFactories);
 }
 
 const cacheServiceFactory = backendPluginApi.createServiceFactory({
@@ -3556,56 +3553,38 @@ function createCookieAuthRefreshMiddleware(options) {
   return router;
 }
 
-const httpRouterServiceFactory$1 = backendPluginApi.createServiceFactory(
-  (options) => ({
-    service: backendPluginApi.coreServices.httpRouter,
-    initialization: "always",
-    deps: {
-      plugin: backendPluginApi.coreServices.pluginMetadata,
-      config: backendPluginApi.coreServices.rootConfig,
-      logger: backendPluginApi.coreServices.logger,
-      lifecycle: backendPluginApi.coreServices.lifecycle,
-      rootHttpRouter: backendPluginApi.coreServices.rootHttpRouter,
-      auth: backendPluginApi.coreServices.auth,
-      httpAuth: backendPluginApi.coreServices.httpAuth
-    },
-    async factory({
-      auth,
+const httpRouterServiceFactory$1 = backendPluginApi.createServiceFactory({
+  service: backendPluginApi.coreServices.httpRouter,
+  initialization: "always",
+  deps: {
+    plugin: backendPluginApi.coreServices.pluginMetadata,
+    config: backendPluginApi.coreServices.rootConfig,
+    lifecycle: backendPluginApi.coreServices.lifecycle,
+    rootHttpRouter: backendPluginApi.coreServices.rootHttpRouter,
+    auth: backendPluginApi.coreServices.auth,
+    httpAuth: backendPluginApi.coreServices.httpAuth
+  },
+  async factory({ auth, httpAuth, config, plugin, rootHttpRouter, lifecycle }) {
+    const router = Router__default.default();
+    rootHttpRouter.use(`/api/${plugin.getId()}`, router);
+    const credentialsBarrier = createCredentialsBarrier({
       httpAuth,
-      config,
-      logger,
-      plugin,
-      rootHttpRouter,
-      lifecycle
-    }) {
-      if (options?.getPath) {
-        logger.warn(
-          `DEPRECATION WARNING: The 'getPath' option for HttpRouterService is deprecated. The ability to reconfigure the '/api/' path prefix for plugins will be removed in the future.`
-        );
+      config
+    });
+    router.use(createAuthIntegrationRouter({ auth }));
+    router.use(createLifecycleMiddleware$1({ lifecycle }));
+    router.use(credentialsBarrier.middleware);
+    router.use(createCookieAuthRefreshMiddleware({ auth, httpAuth }));
+    return {
+      use(handler) {
+        router.use(handler);
+      },
+      addAuthPolicy(policy) {
+        credentialsBarrier.addAuthPolicy(policy);
       }
-      const getPath = options?.getPath ?? ((id) => `/api/${id}`);
-      const path = getPath(plugin.getId());
-      const router = Router__default.default();
-      rootHttpRouter.use(path, router);
-      const credentialsBarrier = createCredentialsBarrier({
-        httpAuth,
-        config
-      });
-      router.use(createAuthIntegrationRouter({ auth }));
-      router.use(createLifecycleMiddleware$1({ lifecycle }));
-      router.use(credentialsBarrier.middleware);
-      router.use(createCookieAuthRefreshMiddleware({ auth, httpAuth }));
-      return {
-        use(handler) {
-          router.use(handler);
-        },
-        addAuthPolicy(policy) {
-          credentialsBarrier.addAuthPolicy(policy);
-        }
-      };
-    }
-  })
-);
+    };
+  }
+});
 
 const httpRouterServiceFactory = httpRouterServiceFactory$1;
 
@@ -3690,52 +3669,77 @@ let DefaultRootHttpRouter$1 = class DefaultRootHttpRouter {
   }
 };
 
+function createHealthRouter(options) {
+  const router = Router__default.default();
+  router.get(
+    ".backstage/health/v1/readiness",
+    async (_request, response) => {
+      const { status, payload } = await options.health.getReadiness();
+      response.status(status).json(payload);
+    }
+  );
+  router.get(
+    ".backstage/health/v1/liveness",
+    async (_request, response) => {
+      const { status, payload } = await options.health.getLiveness();
+      response.status(status).json(payload);
+    }
+  );
+  return router;
+}
+
 function defaultConfigure({ applyDefaults }) {
   applyDefaults();
 }
-const rootHttpRouterServiceFactory$1 = backendPluginApi.createServiceFactory(
-  (options) => ({
-    service: backendPluginApi.coreServices.rootHttpRouter,
-    deps: {
-      config: backendPluginApi.coreServices.rootConfig,
-      rootLogger: backendPluginApi.coreServices.rootLogger,
-      lifecycle: backendPluginApi.coreServices.rootLifecycle
-    },
-    async factory({ config, rootLogger, lifecycle }) {
-      const { indexPath, configure = defaultConfigure } = options ?? {};
-      const logger = rootLogger.child({ service: "rootHttpRouter" });
-      const app = express__default.default();
-      const router = DefaultRootHttpRouter$1.create({ indexPath });
-      const middleware = MiddlewareFactory$1.create({ config, logger });
-      const routes = router.handler();
-      const server = await createHttpServer$1(
-        app,
-        readHttpServerOptions$1(config.getOptionalConfig("backend")),
-        { logger }
-      );
-      configure({
-        app,
-        server,
-        routes,
-        middleware,
-        config,
-        logger,
-        lifecycle,
-        applyDefaults() {
-          app.use(middleware.helmet());
-          app.use(middleware.cors());
-          app.use(middleware.compression());
-          app.use(middleware.logging());
-          app.use(routes);
-          app.use(middleware.notFound());
-          app.use(middleware.error());
-        }
-      });
-      lifecycle.addShutdownHook(() => server.stop());
-      await server.start();
-      return router;
-    }
-  })
+const rootHttpRouterServiceFactoryWithOptions = (options) => backendPluginApi.createServiceFactory({
+  service: backendPluginApi.coreServices.rootHttpRouter,
+  deps: {
+    config: backendPluginApi.coreServices.rootConfig,
+    rootLogger: backendPluginApi.coreServices.rootLogger,
+    lifecycle: backendPluginApi.coreServices.rootLifecycle,
+    health: backendPluginApi.coreServices.rootHealth
+  },
+  async factory({ config, rootLogger, lifecycle, health }) {
+    const { indexPath, configure = defaultConfigure } = options ?? {};
+    const logger = rootLogger.child({ service: "rootHttpRouter" });
+    const app = express__default.default();
+    const router = DefaultRootHttpRouter$1.create({ indexPath });
+    const middleware = MiddlewareFactory$1.create({ config, logger });
+    const routes = router.handler();
+    const healthRouter = createHealthRouter({ health });
+    const server = await createHttpServer$1(
+      app,
+      readHttpServerOptions$1(config.getOptionalConfig("backend")),
+      { logger }
+    );
+    configure({
+      app,
+      server,
+      routes,
+      middleware,
+      config,
+      logger,
+      lifecycle,
+      healthRouter,
+      applyDefaults() {
+        app.use(middleware.helmet());
+        app.use(middleware.cors());
+        app.use(middleware.compression());
+        app.use(middleware.logging());
+        app.use(healthRouter);
+        app.use(routes);
+        app.use(middleware.notFound());
+        app.use(middleware.error());
+      }
+    });
+    lifecycle.addShutdownHook(() => server.stop());
+    await server.start();
+    return router;
+  }
+})();
+const rootHttpRouterServiceFactory$1 = Object.assign(
+  rootHttpRouterServiceFactoryWithOptions,
+  rootHttpRouterServiceFactoryWithOptions()
 );
 
 const rootHttpRouterServiceFactory = rootHttpRouterServiceFactory$1;