From 5aa4ceea6ebedcdc81b8cc9d8ddd0fb317c52f97 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= <freben@gmail.com>
Date: Mon, 22 Feb 2021 20:28:15 +0100
Subject: [PATCH] Make sure to provide dummy routes for all external routes of
 plugins given to DevApp

---
 .changeset/bright-dolphins-mate.md       |  5 +++
 packages/dev-utils/src/devApp/render.tsx | 45 ++++++++++++++++--------
 2 files changed, 36 insertions(+), 14 deletions(-)
 create mode 100644 .changeset/bright-dolphins-mate.md

diff --git a/.changeset/bright-dolphins-mate.md b/.changeset/bright-dolphins-mate.md
new file mode 100644
index 0000000000..ac099c88f0
--- /dev/null
+++ b/.changeset/bright-dolphins-mate.md
@@ -0,0 +1,5 @@
+---
+'@backstage/dev-utils': patch
+---
+
+Make sure to provide dummy routes for all external routes of plugins given to DevApp
diff --git a/packages/dev-utils/src/devApp/render.tsx b/packages/dev-utils/src/devApp/render.tsx
index e1bdf4d0e9..0c3a1395a6 100644
--- a/packages/dev-utils/src/devApp/render.tsx
+++ b/packages/dev-utils/src/devApp/render.tsx
@@ -14,26 +14,30 @@
  * limitations under the License.
  */
 
-import { hot } from 'react-hot-loader';
-import React, { ComponentType, ReactNode } from 'react';
-import ReactDOM from 'react-dom';
-import BookmarkIcon from '@material-ui/icons/Bookmark';
 import {
+  AlertDisplay,
+  AnyApiFactory,
+  ApiFactory,
+  attachComponentData,
   createApp,
-  SidebarPage,
+  createPlugin,
+  createRouteRef,
+  FlatRoutes,
+  IconComponent,
+  OAuthRequestDialog,
+  RouteRef,
   Sidebar,
   SidebarItem,
+  SidebarPage,
   SidebarSpacer,
-  ApiFactory,
-  createPlugin,
-  AlertDisplay,
-  OAuthRequestDialog,
-  AnyApiFactory,
-  IconComponent,
-  FlatRoutes,
-  attachComponentData,
 } from '@backstage/core';
+import { Box } from '@material-ui/core';
+import BookmarkIcon from '@material-ui/icons/Bookmark';
 import SentimentDissatisfiedIcon from '@material-ui/icons/SentimentDissatisfied';
+import React, { ComponentType, ReactNode } from 'react';
+import ReactDOM from 'react-dom';
+import { hot } from 'react-hot-loader';
+import { Route } from 'react-router';
 
 const GatheringRoute: (props: {
   path: string;
@@ -128,9 +132,22 @@ class DevAppBuilder {
    * Build a DevApp component using the resources registered so far
    */
   build(): ComponentType<{}> {
+    const dummyRouteRef = createRouteRef({ title: 'Page of another plugin' });
+    const DummyPage = () => <Box p={3}>Page belonging to another plugin.</Box>;
+    attachComponentData(DummyPage, 'core.mountPoint', dummyRouteRef);
+
     const app = createApp({
       apis: this.apis,
       plugins: this.plugins,
+      bindRoutes: ({ bind }) => {
+        for (const plugin of this.plugins ?? []) {
+          const targets: Record<string, RouteRef<any>> = {};
+          for (const routeKey of Object.keys(plugin.externalRoutes)) {
+            targets[routeKey] = dummyRouteRef;
+          }
+          bind(plugin.externalRoutes, targets);
+        }
+      },
     });
 
     const AppProvider = app.getProvider();
@@ -145,13 +162,13 @@ class DevAppBuilder {
           <AlertDisplay />
           <OAuthRequestDialog />
           {this.rootChildren}
-
           <AppRouter>
             <SidebarPage>
               {sidebar}
               <FlatRoutes>
                 {this.routes}
                 {deprecatedAppRoutes}
+                <Route path="/_external_route" element={<DummyPage />} />
               </FlatRoutes>
             </SidebarPage>
           </AppRouter>