From 0816f8237a41ac48a6a51fe984ab85c00e2c8d54 Mon Sep 17 00:00:00 2001 From: Joe Porpeglia Date: Fri, 18 Feb 2022 15:33:51 -0500 Subject: [PATCH] Improve error message when permissions are enabled without backend-to-backend authentication Signed-off-by: Joe Porpeglia --- .changeset/serious-eyes-fix.md | 5 +++++ plugins/permission-node/src/ServerPermissionClient.test.ts | 2 +- plugins/permission-node/src/ServerPermissionClient.ts | 2 +- 3 files changed, 7 insertions(+), 2 deletions(-) create mode 100644 .changeset/serious-eyes-fix.md diff --git a/.changeset/serious-eyes-fix.md b/.changeset/serious-eyes-fix.md new file mode 100644 index 0000000000..5b4f86345e --- /dev/null +++ b/.changeset/serious-eyes-fix.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-permission-node': patch +--- + +Improved error message permissions are enabled without backend-to-backend authentication. diff --git a/plugins/permission-node/src/ServerPermissionClient.test.ts b/plugins/permission-node/src/ServerPermissionClient.test.ts index 9fa1eadb5e..53300061a0 100644 --- a/plugins/permission-node/src/ServerPermissionClient.test.ts +++ b/plugins/permission-node/src/ServerPermissionClient.test.ts @@ -113,7 +113,7 @@ describe('ServerPermissionClient', () => { tokenManager: ServerTokenManager.noop(), }), ).toThrowError( - 'You must configure at least one key in backend.auth.keys if permissions are enabled.', + 'Backend-to-backend authentication must be configured before enabling permissions. Read more here https://backstage.io/docs/tutorials/backend-to-backend-auth', ); }); }); diff --git a/plugins/permission-node/src/ServerPermissionClient.ts b/plugins/permission-node/src/ServerPermissionClient.ts index f22779c8e8..8c03016268 100644 --- a/plugins/permission-node/src/ServerPermissionClient.ts +++ b/plugins/permission-node/src/ServerPermissionClient.ts @@ -56,7 +56,7 @@ export class ServerPermissionClient implements PermissionAuthorizer { (tokenManager as any).isInsecureServerTokenManager ) { throw new Error( - 'You must configure at least one key in backend.auth.keys if permissions are enabled.', + 'Backend-to-backend authentication must be configured before enabling permissions. Read more here https://backstage.io/docs/tutorials/backend-to-backend-auth', ); }