catalog: fix EntitySwitch to render default case

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
backstage · Mar 15, 2022 · d4afa7e · d4afa7e
1 parent 12693d5
commit d4afa7e
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 4 deletions.
diff --git a/.changeset/shy-seals-deny.md b/.changeset/shy-seals-deny.md
@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-catalog': patch
+---
+
+Fix for `EntitySwitch` not properly falling back to render the default entity page when the entity is missing.
diff --git a/plugins/catalog/src/components/EntitySwitch/EntitySwitch.test.tsx b/plugins/catalog/src/components/EntitySwitch/EntitySwitch.test.tsx
@@ -15,7 +15,10 @@
  */
 
 import { Entity } from '@backstage/catalog-model';
-import { EntityProvider } from '@backstage/plugin-catalog-react';
+import {
+  AsyncEntityProvider,
+  EntityProvider,
+} from '@backstage/plugin-catalog-react';
 import { render } from '@testing-library/react';
 import React from 'react';
 import { isKind } from './conditions';
@@ -76,6 +79,18 @@ describe('EntitySwitch', () => {
     expect(rendered.queryByText('A')).not.toBeInTheDocument();
     expect(rendered.queryByText('B')).not.toBeInTheDocument();
     expect(rendered.queryByText('C')).toBeInTheDocument();
+
+    rendered.rerender(
+      <Wrapper>
+        <AsyncEntityProvider entity={undefined} loading={false}>
+          {content}
+        </AsyncEntityProvider>
+      </Wrapper>,
+    );
+
+    expect(rendered.queryByText('A')).not.toBeInTheDocument();
+    expect(rendered.queryByText('B')).not.toBeInTheDocument();
+    expect(rendered.queryByText('C')).toBeInTheDocument();
   });
 
   it('should switch child when filters switch', () => {

diff --git a/plugins/catalog/src/components/EntitySwitch/EntitySwitch.tsx b/plugins/catalog/src/components/EntitySwitch/EntitySwitch.tsx
@@ -63,7 +63,7 @@ export interface EntitySwitchProps {
 
 /** @public */
 export const EntitySwitch = (props: EntitySwitchProps) => {
-  const { entity } = useAsyncEntity();
+  const { entity, loading } = useAsyncEntity();
   const apis = useApiHolder();
   const results = useElementFilter(
     props.children,
@@ -75,19 +75,31 @@ export const EntitySwitch = (props: EntitySwitchProps) => {
         })
         .getElements()
         .flatMap<SwitchCaseResult>((element: ReactElement) => {
-          if (!entity) {
+          // Nothing is rendered while loading
+          if (loading) {
             return [];
           }
+
           const { if: condition, children: elementsChildren } =
             element.props as EntitySwitchCase;
+
+          // If the entity is missing or there is an error, render the default page
+          if (!entity) {
+            return [
+              {
+                if: condition === undefined,
+                children: elementsChildren,
+              },
+            ];
+          }
           return [
             {
               if: condition?.(entity, { apis }) ?? true,
               children: elementsChildren,
             },
           ];
         }),
-    [apis, entity],
+    [apis, entity, loading],
   );
   const hasAsyncCases = results.some(
     r => typeof r.if === 'object' && 'then' in r.if,