From 27e1ab0ec4222dceaa054b8e54e9a85181dc68f5 Mon Sep 17 00:00:00 2001
From: Brian Fletcher <brian@roadie.io>
Date: Fri, 28 Jan 2022 13:51:47 +0000
Subject: [PATCH] addressing review suggestions

Signed-off-by: Brian Fletcher <brian@roadie.io>
---
 .changeset/quick-jars-wait.md                    | 4 ++--
 plugins/proxy-backend/src/service/router.test.ts | 2 +-
 plugins/proxy-backend/src/service/router.ts      | 4 ++--
 3 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/.changeset/quick-jars-wait.md b/.changeset/quick-jars-wait.md
index 61bde0d377..bbf6b42a89 100644
--- a/.changeset/quick-jars-wait.md
+++ b/.changeset/quick-jars-wait.md
@@ -2,7 +2,7 @@
 '@backstage/plugin-proxy-backend': patch
 ---
 
-If one of the configured proxies is configured badly enough to cause an exception when the middleware is being built it can now be configured to pass the bad proxy by and continue the server startup. Previously the backend would fail to startup.
+Adds a new option `skipInvalidTargets` for the proxy `createRouter` which allows the proxy backend to be started with an invalid proxy configuration. If configured, it will simply skip the failed proxy and mount the other valid proxies.
 
 To configure it to pass by failing proxies:
 
@@ -11,7 +11,7 @@ const router = await createRouter({
   config,
   logger,
   discovery,
-  skipBrokenProxies: true,
+  skipInvalidProxies: true,
 });
 ```
 
diff --git a/plugins/proxy-backend/src/service/router.test.ts b/plugins/proxy-backend/src/service/router.test.ts
index 6b4d6b21a7..3bfcc889f4 100644
--- a/plugins/proxy-backend/src/service/router.test.ts
+++ b/plugins/proxy-backend/src/service/router.test.ts
@@ -113,7 +113,7 @@ describe('createRouter', () => {
         config,
         logger,
         discovery,
-        skipBrokenProxies: true,
+        skipInvalidProxies: true,
       });
       expect((logger.warn as jest.Mock).mock.calls[0][0]).toEqual(
         'skipped configuring /test due to Proxy target must be a string',
diff --git a/plugins/proxy-backend/src/service/router.ts b/plugins/proxy-backend/src/service/router.ts
index 7ea59d74eb..ca2c7870d8 100644
--- a/plugins/proxy-backend/src/service/router.ts
+++ b/plugins/proxy-backend/src/service/router.ts
@@ -51,7 +51,7 @@ export interface RouterOptions {
   logger: Logger;
   config: Config;
   discovery: PluginEndpointDiscovery;
-  skipBrokenProxies?: boolean;
+  skipInvalidProxies?: boolean;
 }
 
 export interface ProxyConfig extends Options {
@@ -194,7 +194,7 @@ export async function createRouter(
         buildMiddleware(pathPrefix, options.logger, route, proxyRouteConfig),
       );
     } catch (e) {
-      if (options.skipBrokenProxies) {
+      if (options.skipInvalidProxies) {
         options.logger.warn(`skipped configuring ${route} due to ${e.message}`);
       } else {
         throw e;