From e9a03c95f00d9459aa6ac6e82c54456604f638d1 Mon Sep 17 00:00:00 2001
From: Camila Belo <camilaibs@gmail.com>
Date: Wed, 12 Jun 2024 16:51:07 +0200
Subject: [PATCH] refactor(backend-common): complete deprecating the legacy
 backend commons

Signed-off-by: Camila Belo <camilaibs@gmail.com>
---
 .changeset/twenty-seals-guess.md                          | 5 +++++
 packages/backend-common/api-report.md                     | 6 +++---
 packages/backend-common/src/logging/createRootLogger.ts   | 2 ++
 packages/backend-common/src/middleware/notFoundHandler.ts | 1 +
 packages/backend-common/src/service/types.ts              | 1 +
 5 files changed, 12 insertions(+), 3 deletions(-)
 create mode 100644 .changeset/twenty-seals-guess.md

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 977809071b..899908f098 100644
--- a/packages/backend-common/api-report.md
+++ b/packages/backend-common/api-report.md
@@ -467,7 +467,7 @@ export function makeLegacyPlugin<
   }>,
 ) => BackendFeature;
 
-// @public
+// @public @deprecated
 export function notFoundHandler(): RequestHandler;
 
 // @public (undocumented)
@@ -540,7 +540,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;
@@ -604,7 +604,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 16554750ef..2978bef61e 100644
--- a/packages/backend-common/src/logging/createRootLogger.ts
+++ b/packages/backend-common/src/logging/createRootLogger.ts
@@ -43,6 +43,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 4f29b4f824..d3ced54a67 100644
--- a/packages/backend-common/src/middleware/notFoundHandler.ts
+++ b/packages/backend-common/src/middleware/notFoundHandler.ts
@@ -27,6 +27,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 = {
   /**