move over most trivial services to backend-defaults

.changeset/lucky-taxis-rule.md

@@ -2,4 +2,8 @@
 '@backstage/backend-defaults': patch
 ---
 
-Added the `schedulerServiceFactory` and its implementation, migrated over from `@backstage/backend-app-api`
+Added core service factories and implementations from
+`@backstage/backend-app-api`. They are now available as subpath exports, e.g.
+`@backstage/backend-defaults/scheduler` is where the service factory and default
+implementation of `coreServices.scheduler` now lives. They have been marked as
+deprecated in their old locations.

.changeset/rude-kings-press.md

@@ -2,4 +2,7 @@
 '@backstage/backend-app-api': patch
 ---
 
-Deprecated `schedulerServiceFactory`, which should now instead be imported from `@backstage/backend-defaults/scheduler` instead
+Deprecated core service factories and implementations and moved them over to
+subpath exports on `@backstage/backend-defaults` instead. E.g.
+`@backstage/backend-defaults/scheduler` is where the service factory and default
+implementation of `coreServices.scheduler` now lives.

packages/backend-app-api/api-report.md

@@ -65,7 +65,7 @@ export interface Backend {
   stop(): Promise<void>;
 }
 
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export const cacheServiceFactory: () => ServiceFactory<CacheClient, 'plugin'>;
 
 // @public (undocumented)
@@ -100,7 +100,7 @@ export interface CreateSpecializedBackendOptions {
   defaultServiceFactories: ServiceFactoryOrFunction[];
 }
 
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export const databaseServiceFactory: () => ServiceFactory<
   PluginDatabaseManager,
   'plugin'
@@ -121,7 +121,7 @@ export interface DefaultRootHttpRouterOptions {
   indexPath?: string | false;
 }
 
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export const discoveryServiceFactory: () => ServiceFactory<
   DiscoveryService,
   'plugin'
@@ -137,7 +137,7 @@ export interface ExtendedHttpServer extends http.Server {
   stop(): Promise<void>;
 }
 
-// @public
+// @public @deprecated
 export class HostDiscovery implements DiscoveryService {
   static fromConfig(
     config: Config,
@@ -190,13 +190,13 @@ export type HttpServerOptions = {
   };
 };
 
-// @public
+// @public @deprecated
 export type IdentityFactoryOptions = {
   issuer?: string;
   algorithms?: string[];
 };
 
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export const identityServiceFactory: (
   options?: IdentityFactoryOptions | undefined,
 ) => ServiceFactory<IdentityService, 'plugin'>;
@@ -208,7 +208,7 @@ export interface LifecycleMiddlewareOptions {
   startupRequestPauseTimeout?: HumanDuration;
 }
 
-// @public
+// @public @deprecated
 export const lifecycleServiceFactory: () => ServiceFactory<
   LifecycleService,
   'plugin'
@@ -255,7 +255,7 @@ export interface MiddlewareFactoryOptions {
   logger: LoggerService;
 }
 
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export const permissionsServiceFactory: () => ServiceFactory<
   PermissionsService,
   'plugin'
@@ -270,15 +270,15 @@ export function readHelmetOptions(config?: Config): HelmetOptions;
 // @public
 export function readHttpServerOptions(config?: Config): HttpServerOptions;
 
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export interface RootConfigFactoryOptions {
   argv?: string[];
   remote?: Pick<RemoteConfigSourceOptions, 'reloadInterval'>;
   // (undocumented)
   watch?: boolean;
 }
 
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export const rootConfigServiceFactory: (
   options?: RootConfigFactoryOptions | undefined,
 ) => ServiceFactory<RootConfigService, 'root'>;
@@ -314,7 +314,7 @@ export const rootHttpRouterServiceFactory: (
   options?: RootHttpRouterFactoryOptions | undefined,
 ) => ServiceFactory<RootHttpRouterService, 'root'>;
 
-// @public
+// @public @deprecated
 export const rootLifecycleServiceFactory: () => ServiceFactory<
   RootLifecycleService,
   'root'
@@ -332,13 +332,13 @@ export const schedulerServiceFactory: () => ServiceFactory<
   'plugin'
 >;
 
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export const tokenManagerServiceFactory: () => ServiceFactory<
   TokenManagerService,
   'plugin'
 >;
 
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export const urlReaderServiceFactory: () => ServiceFactory<UrlReader, 'plugin'>;
 
 // @public (undocumented)

packages/backend-app-api/src/services/implementations/cache/cacheServiceFactory.ts

@@ -20,7 +20,10 @@ import {
   createServiceFactory,
 } from '@backstage/backend-plugin-api';
 
-/** @public */
+/**
+ * @public
+ * @deprecated Please import from `@backstage/backend-defaults/cache` instead.
+ */
 export const cacheServiceFactory = createServiceFactory({
   service: coreServices.cache,
   deps: {

packages/backend-app-api/src/services/implementations/config/rootConfigServiceFactory.ts

@@ -23,7 +23,10 @@ import {
   RemoteConfigSourceOptions,
 } from '@backstage/config-loader';
 
-/** @public */
+/**
+ * @public
+ * @deprecated Please import from `@backstage/backend-defaults/rootConfig` instead.
+ */
 export interface RootConfigFactoryOptions {
   /**
    * Process arguments to use instead of the default `process.argv()`.
@@ -37,7 +40,10 @@ export interface RootConfigFactoryOptions {
   watch?: boolean;
 }
 
-/** @public */
+/**
+ * @public
+ * @deprecated Please import from `@backstage/backend-defaults/rootConfig` instead.
+ */
 export const rootConfigServiceFactory = createServiceFactory(
   (options?: RootConfigFactoryOptions) => ({
     service: coreServices.rootConfig,

packages/backend-app-api/src/services/implementations/database/databaseServiceFactory.ts

@@ -21,7 +21,10 @@ import {
 } from '@backstage/backend-plugin-api';
 import { ConfigReader } from '@backstage/config';
 
-/** @public */
+/**
+ * @public
+ * @deprecated Please import from `@backstage/backend-defaults/database` instead.
+ */
 export const databaseServiceFactory = createServiceFactory({
   service: coreServices.database,
   deps: {

packages/backend-app-api/src/services/implementations/discovery/HostDiscovery.ts

@@ -29,6 +29,7 @@ type Target = string | { internal: string; external: string };
  * resolved to the same host, so there won't be any balancing of internal traffic.
  *
  * @public
+ * @deprecated Please import from `@backstage/backend-defaults/discovery` instead.
  */
 export class HostDiscovery implements DiscoveryService {
   /**

packages/backend-app-api/src/services/implementations/discovery/discoveryServiceFactory.ts

@@ -20,7 +20,10 @@ import {
 } from '@backstage/backend-plugin-api';
 import { HostDiscovery } from './HostDiscovery';
 
-/** @public */
+/**
+ * @public
+ * @deprecated Please import from `@backstage/backend-defaults/discovery` instead.
+ */
 export const discoveryServiceFactory = createServiceFactory({
   service: coreServices.discovery,
   deps: {

packages/backend-app-api/src/services/implementations/identity/identityServiceFactory.ts

@@ -24,16 +24,22 @@ import { DefaultIdentityClient } from '@backstage/plugin-auth-node';
  * An identity client options object which allows extra configurations
  *
  * @public
+ * @deprecated Please migrate to the new `coreServices.auth`, `coreServices.httpAuth`, and `coreServices.userInfo` services as needed instead
  */
 export type IdentityFactoryOptions = {
   issuer?: string;
 
-  /** JWS "alg" (Algorithm) Header Parameter values. Defaults to an array containing just ES256.
-   * More info on supported algorithms: https://github.com/panva/jose */
+  /**
+   * JWS "alg" (Algorithm) Header Parameter values. Defaults to an array containing just ES256.
+   * More info on supported algorithms: https://github.com/panva/jose
+   */
   algorithms?: string[];
 };
 
-/** @public */
+/**
+ * @public
+ * @deprecated Please migrate to the new `coreServices.auth`, `coreServices.httpAuth`, and `coreServices.userInfo` services as needed instead
+ */
 export const identityServiceFactory = createServiceFactory(
   (options?: IdentityFactoryOptions) => ({
     service: coreServices.identity,

packages/backend-app-api/src/services/implementations/lifecycle/lifecycleServiceFactory.ts

@@ -26,7 +26,10 @@ import {
   createServiceFactory,
 } from '@backstage/backend-plugin-api';
 
-/** @internal */
+/**
+ * @internal
+ * @deprecated
+ */
 export class BackendPluginLifecycleImpl implements LifecycleService {
   constructor(
     private readonly logger: LoggerService,
@@ -85,7 +88,9 @@ export class BackendPluginLifecycleImpl implements LifecycleService {
 
 /**
  * Allows plugins to register shutdown hooks that are run when the process is about to exit.
+ *
  * @public
+ * @deprecated Please import from `@backstage/backend-defaults/lifecycle` instead.
  */
 export const lifecycleServiceFactory = createServiceFactory({
   service: coreServices.lifecycle,

packages/backend-app-api/src/services/implementations/permissions/permissionsServiceFactory.ts

@@ -20,7 +20,10 @@ import {
 } from '@backstage/backend-plugin-api';
 import { ServerPermissionClient } from '@backstage/plugin-permission-node';
 
-/** @public */
+/**
+ * @public
+ * @deprecated Please import from `@backstage/backend-defaults/permissions` instead.
+ */
 export const permissionsServiceFactory = createServiceFactory({
   service: coreServices.permissions,
   deps: {

packages/backend-app-api/src/services/implementations/rootLifecycle/rootLifecycleServiceFactory.ts

@@ -25,7 +25,10 @@ import {
   LoggerService,
 } from '@backstage/backend-plugin-api';
 
-/** @internal */
+/**
+ * @internal
+ * @deprecated
+ */
 export class BackendLifecycleImpl implements RootLifecycleService {
   constructor(private readonly logger: LoggerService) {}
 
@@ -108,6 +111,7 @@ export class BackendLifecycleImpl implements RootLifecycleService {
  * Allows plugins to register shutdown hooks that are run when the process is about to exit.
  *
  * @public
+ * @deprecated Please import from `@backstage/backend-defaults/rootLifecycle` instead.
  */
 export const rootLifecycleServiceFactory = createServiceFactory({
   service: coreServices.rootLifecycle,

packages/backend-app-api/src/services/implementations/tokenManager/tokenManagerServiceFactory.ts

@@ -20,7 +20,10 @@ import {
 } from '@backstage/backend-plugin-api';
 import { ServerTokenManager } from '@backstage/backend-common';
 
-/** @public */
+/**
+ * @public
+ * @deprecated Please migrate to the new `coreServices.auth`, `coreServices.httpAuth`, and `coreServices.userInfo` services as needed instead
+ */
 export const tokenManagerServiceFactory = createServiceFactory({
   service: coreServices.tokenManager,
   deps: {

packages/backend-app-api/src/services/implementations/urlReader/urlReaderServiceFactory.ts

@@ -20,7 +20,10 @@ import {
   createServiceFactory,
 } from '@backstage/backend-plugin-api';
 
-/** @public */
+/**
+ * @public
+ * @deprecated Please import from `@backstage/backend-defaults/urlReader` instead.
+ */
 export const urlReaderServiceFactory = createServiceFactory({
   service: coreServices.urlReader,
   deps: {

packages/backend-app-api/src/wiring/BackendInitializer.ts

@@ -20,9 +20,9 @@ import {
   coreServices,
   ServiceRef,
   ServiceFactory,
+  LifecycleService,
+  RootLifecycleService,
 } from '@backstage/backend-plugin-api';
-import { BackendLifecycleImpl } from '../services/implementations/rootLifecycle/rootLifecycleServiceFactory';
-import { BackendPluginLifecycleImpl } from '../services/implementations/lifecycle/lifecycleServiceFactory';
 import { ServiceOrExtensionPoint } from './types';
 // Direct internal import to avoid duplication
 // eslint-disable-next-line @backstage/no-forbidden-package-imports
@@ -345,27 +345,42 @@ export class BackendInitializer {
   }
 
   // Bit of a hacky way to grab the lifecycle services, potentially find a nicer way to do this
-  async #getRootLifecycleImpl(): Promise<BackendLifecycleImpl> {
+  async #getRootLifecycleImpl(): Promise<
+    RootLifecycleService & {
+      startup(): Promise<void>;
+      shutdown(): Promise<void>;
+    }
+  > {
     const lifecycleService = await this.#serviceRegistry.get(
       coreServices.rootLifecycle,
       'root',
     );
-    if (lifecycleService instanceof BackendLifecycleImpl) {
-      return lifecycleService;
+
+    const service = lifecycleService as any;
+    if (
+      service &&
+      typeof service.startup === 'function' &&
+      typeof service.shutdown === 'function'
+    ) {
+      return service;
     }
+
     throw new Error('Unexpected root lifecycle service implementation');
   }
 
   async #getPluginLifecycleImpl(
     pluginId: string,
-  ): Promise<BackendPluginLifecycleImpl> {
+  ): Promise<LifecycleService & { startup(): Promise<void> }> {
     const lifecycleService = await this.#serviceRegistry.get(
       coreServices.lifecycle,
       pluginId,
     );
-    if (lifecycleService instanceof BackendPluginLifecycleImpl) {
-      return lifecycleService;
+
+    const service = lifecycleService as any;
+    if (service && typeof service.startup === 'function') {
+      return service;
     }
+
     throw new Error('Unexpected plugin lifecycle service implementation');
   }
 }

packages/backend-defaults/api-report-cache.md

@@ -0,0 +1,13 @@
+## API Report File for "@backstage/backend-defaults"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+import { CacheClient } from '@backstage/backend-common';
+import { ServiceFactory } from '@backstage/backend-plugin-api';
+
+// @public (undocumented)
+export const cacheServiceFactory: () => ServiceFactory<CacheClient, 'plugin'>;
+
+// (No @packageDocumentation comment for this package)
+```

packages/backend-defaults/api-report-database.md

@@ -0,0 +1,16 @@
+## API Report File for "@backstage/backend-defaults"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+import { PluginDatabaseManager } from '@backstage/backend-common';
+import { ServiceFactory } from '@backstage/backend-plugin-api';
+
+// @public (undocumented)
+export const databaseServiceFactory: () => ServiceFactory<
+  PluginDatabaseManager,
+  'plugin'
+>;
+
+// (No @packageDocumentation comment for this package)
+```