diff --git a/.changeset/twenty-seals-guess.md b/.changeset/twenty-seals-guess.md new file mode 100644 index 0000000000..a206105b46 --- /dev/null +++ b/.changeset/twenty-seals-guess.md @@ -0,0 +1,5 @@ +--- +'@backstage/backend-common': patch +--- + +Finalizes the deprecation of legacy backend utilities. Deprecated utilities include the `ServiceBuilder` type, `notFoundHandler` and `redactWintonLogLine` functions. diff --git a/packages/backend-common/api-report.md b/packages/backend-common/api-report.md index 615e26b24c..c8673da9d2 100644 --- a/packages/backend-common/api-report.md +++ b/packages/backend-common/api-report.md @@ -468,7 +468,7 @@ export function makeLegacyPlugin< }>, ) => BackendFeature; -// @public +// @public @deprecated export function notFoundHandler(): RequestHandler; // @public (undocumented) @@ -541,7 +541,7 @@ export const ReadUrlResponseFactory: typeof ReadUrlResponseFactory_2; export type ReadUrlResponseFactoryFromStreamOptions = ReadUrlResponseFactoryFromStreamOptions_2; -// @public +// @public @deprecated export function redactWinstonLogLine( info: winston.Logform.TransformableInfo, ): winston.Logform.TransformableInfo; @@ -605,7 +605,7 @@ export interface ServerTokenManagerOptions { logger: LoggerService; } -// @public +// @public @deprecated export type ServiceBuilder = { loadConfig(config: Config): ServiceBuilder; setPort(port: number): ServiceBuilder; diff --git a/packages/backend-common/src/logging/createRootLogger.ts b/packages/backend-common/src/logging/createRootLogger.ts index 99dc052382..20ee272b79 100644 --- a/packages/backend-common/src/logging/createRootLogger.ts +++ b/packages/backend-common/src/logging/createRootLogger.ts @@ -44,6 +44,8 @@ export const setRootLoggerRedactionList = ( * and replaces them with the corresponding identifier. * * @public + * @deprecated This utility is being deprecated along with the {@link https://github.com/backstage/backstage/issues/24493 |legacy backend system}. + * Migrate your {@link https://backstage.io/docs/backend-system/building-backends/migrating | backend} and {@link https://backstage.io/docs/backend-system/building-plugins-and-modules/migrating | plugin} to the new system and use the {@link https://github.com/backstage/backstage/pull/24730 | RedactionsService} for customization instead. */ export function redactWinstonLogLine( info: winston.Logform.TransformableInfo, diff --git a/packages/backend-common/src/middleware/notFoundHandler.ts b/packages/backend-common/src/middleware/notFoundHandler.ts index fe30590863..19c01ede9c 100644 --- a/packages/backend-common/src/middleware/notFoundHandler.ts +++ b/packages/backend-common/src/middleware/notFoundHandler.ts @@ -28,6 +28,7 @@ import { getRootLogger } from '../logging'; * * @public * @returns An Express request handler + * @deprecated Use {@link @backstage/backend-app-api#MiddlewareFactory.create.notFound} instead */ export function notFoundHandler(): RequestHandler { return MiddlewareFactory.create({ diff --git a/packages/backend-common/src/service/types.ts b/packages/backend-common/src/service/types.ts index 1fd5b9fff1..bb4f98cd1c 100644 --- a/packages/backend-common/src/service/types.ts +++ b/packages/backend-common/src/service/types.ts @@ -24,6 +24,7 @@ import { LoggerService } from '@backstage/backend-plugin-api'; * A helper for building backend service instances. * * @public + * @deprecated This type is being deprecated along with the {@link @backstage/backend-common#createServiceBuilder} function. */ export type ServiceBuilder = { /**