move over most trivial services to backend-defaults

Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2024-04-24 15:15:10 +02:00
parent ddfd6608c5
commit b0210ec5b6
48 changed files with 1412 additions and 52 deletions
@@ -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,7 +270,7 @@ 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'>;
@@ -278,7 +278,7 @@ export interface RootConfigFactoryOptions {
  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)
@@ -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: {
@@ -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,
@@ -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: {
@@ -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 {
  /**
@@ -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: {
@@ -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,
@@ -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,
@@ -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: {
@@ -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,
@@ -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: {
@@ -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: {
@@ -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');
  }
 }