Merge pull request #25169 from backstage/camilaibs/nbs10-complete-deprecating-legacy-backend

[NBS1.0] Complete deprecating the legacy backend utilities
This commit is contained in:
Fredrik Adelöw
2024-06-12 17:42:37 +02:00
committed by GitHub
5 changed files with 12 additions and 3 deletions
+5
View File
@@ -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.
+3 -3
View File
@@ -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;
@@ -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,
@@ -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({
@@ -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 = {
/**