From 1c3d6fa2b24b6acab574be8a39a7270db41ea6d5 Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Sat, 23 Sep 2023 17:04:27 +0200
Subject: [PATCH] backend-common: deprecate hot reload helpers

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
---
 .changeset/wet-timers-chew.md         | 5 +++++
 packages/backend-common/api-report.md | 4 ++--
 packages/backend-common/src/hot.ts    | 2 ++
 3 files changed, 9 insertions(+), 2 deletions(-)
 create mode 100644 .changeset/wet-timers-chew.md

diff --git a/.changeset/wet-timers-chew.md b/.changeset/wet-timers-chew.md
new file mode 100644
index 0000000000..3be6368331
--- /dev/null
+++ b/.changeset/wet-timers-chew.md
@@ -0,0 +1,5 @@
+---
+'@backstage/backend-common': patch
+---
+
+The `useHotCleanup` and `useHotMemoize` helpers are now deprecated, since hot module reloads for backend are being phased out.
diff --git a/packages/backend-common/api-report.md b/packages/backend-common/api-report.md
index f0fa15efb0..ab640ccd9b 100644
--- a/packages/backend-common/api-report.md
+++ b/packages/backend-common/api-report.md
@@ -785,12 +785,12 @@ export type UrlReadersOptions = {
   factories?: ReaderFactory[];
 };
 
-// @public
+// @public @deprecated
 export function useHotCleanup(
   _module: NodeModule,
   cancelEffect: () => void,
 ): void;
 
-// @public
+// @public @deprecated
 export function useHotMemoize<T>(_module: NodeModule, valueFactory: () => T): T;
 ```
diff --git a/packages/backend-common/src/hot.ts b/packages/backend-common/src/hot.ts
index 7148778b8c..94ebf52307 100644
--- a/packages/backend-common/src/hot.ts
+++ b/packages/backend-common/src/hot.ts
@@ -47,6 +47,7 @@ function findAllAncestors(_module: NodeModule): NodeModule[] {
  * Useful for cleaning intervals, timers, requests etc
  *
  * @public
+ * @deprecated Hot module reloading is no longer supported for backends.
  * @example
  * ```ts
  * const intervalId = setInterval(doStuff, 1000);
@@ -80,6 +81,7 @@ const CURRENT_HOT_MEMOIZE_INDEX_KEY = 'backstage.io/hmr-memoize-key';
  * stateful parts of the backend, e.g. to retain a database.
  *
  * @public
+ * @deprecated Hot module reloading is no longer supported for backends.
  * @example
  * ```ts
  * const db = useHotMemoize(module, () => createDB(dbParams));