From fcb9356320332a2ceae414a8d124bbc0b6c9ecd6 Mon Sep 17 00:00:00 2001
From: Johan Haals <johan.haals@gmail.com>
Date: Tue, 20 Aug 2024 11:13:43 +0200
Subject: [PATCH] permission-backend: Deprecate createRouter

Signed-off-by: Johan Haals <johan.haals@gmail.com>
---
 .changeset/witty-years-cry.md                    | 5 +++++
 plugins/permission-backend/api-report.md         | 8 ++++----
 plugins/permission-backend/src/service/router.ts | 6 ++++--
 3 files changed, 13 insertions(+), 6 deletions(-)
 create mode 100644 .changeset/witty-years-cry.md

diff --git a/.changeset/witty-years-cry.md b/.changeset/witty-years-cry.md
new file mode 100644
index 0000000000..48c566730b
--- /dev/null
+++ b/.changeset/witty-years-cry.md
@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-permission-backend': patch
+---
+
+Deprecated `createRouter` and its router options in favour of the new backend system.
diff --git a/plugins/permission-backend/api-report.md b/plugins/permission-backend/api-report.md
index d8d40be440..bd976a8d7b 100644
--- a/plugins/permission-backend/api-report.md
+++ b/plugins/permission-backend/api-report.md
@@ -4,24 +4,24 @@
 
 ```ts
 import { AuthService } from '@backstage/backend-plugin-api';
-import { Config } from '@backstage/config';
 import { DiscoveryService } from '@backstage/backend-plugin-api';
 import express from 'express';
 import { HttpAuthService } from '@backstage/backend-plugin-api';
 import { IdentityApi } from '@backstage/plugin-auth-node';
 import { LoggerService } from '@backstage/backend-plugin-api';
 import { PermissionPolicy } from '@backstage/plugin-permission-node';
+import { RootConfigService } from '@backstage/backend-plugin-api';
 import { UserInfoService } from '@backstage/backend-plugin-api';
 
-// @public
+// @public @deprecated
 export function createRouter(options: RouterOptions): Promise<express.Router>;
 
-// @public
+// @public @deprecated
 export interface RouterOptions {
   // (undocumented)
   auth?: AuthService;
   // (undocumented)
-  config: Config;
+  config: RootConfigService;
   // (undocumented)
   discovery: DiscoveryService;
   // (undocumented)
diff --git a/plugins/permission-backend/src/service/router.ts b/plugins/permission-backend/src/service/router.ts
index fd33f0b629..db2b72f95c 100644
--- a/plugins/permission-backend/src/service/router.ts
+++ b/plugins/permission-backend/src/service/router.ts
@@ -42,7 +42,6 @@ import {
 import { PermissionIntegrationClient } from './PermissionIntegrationClient';
 import { memoize } from 'lodash';
 import DataLoader from 'dataloader';
-import { Config } from '@backstage/config';
 import {
   AuthService,
   BackstageCredentials,
@@ -51,6 +50,7 @@ import {
   DiscoveryService,
   HttpAuthService,
   LoggerService,
+  RootConfigService,
   UserInfoService,
 } from '@backstage/backend-plugin-api';
 
@@ -97,13 +97,14 @@ const evaluatePermissionRequestBatchSchema: z.ZodSchema<EvaluatePermissionReques
  * {@link createRouter}.
  *
  * @public
+ * @deprecated Please migrate to the new backend system as this will be removed in the future.
  */
 export interface RouterOptions {
   logger: LoggerService;
   discovery: DiscoveryService;
   policy: PermissionPolicy;
   identity?: IdentityApi;
-  config: Config;
+  config: RootConfigService;
   auth?: AuthService;
   httpAuth?: HttpAuthService;
   userInfo?: UserInfoService;
@@ -190,6 +191,7 @@ const handleRequest = async (
  * Creates a new {@link express#Router} which provides the backend API
  * for the permission system.
  *
+ * @deprecated Please migrate to the new backend system as this will be removed in the future.
  * @public
  */
 export async function createRouter(