catalog: Display warning when entity is orphan

Signed-off-by: Johan Haals <johan.haals@gmail.com>
2021-05-18 11:24:53 +02:00
parent 991dd299eb
commit dc4a5a90ac
4 changed files with 179 additions and 0 deletions
@@ -0,0 +1,104 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { ApiProvider, ApiRegistry, ConfigReader } from '@backstage/core';
+import {
+  ScmIntegrationsApi,
+  scmIntegrationsApiRef,
+} from '@backstage/integration-react';
+import { EntityProvider } from '@backstage/plugin-catalog-react';
+import { renderInTestApp } from '@backstage/test-utils';
+import React from 'react';
+import { EntityOrphanWarning } from './EntityOrphanWarning';
+
+describe('<EntityOrphanWarning />', () => {
+  it('renders EntityOrphanWarning if the entity is orphan', async () => {
+    const entity = {
+      apiVersion: 'v1',
+      kind: 'Component',
+      metadata: {
+        name: 'software',
+        description: 'This is the description',
+        annotations: { 'backstage.io/orphan': 'true' },
+      },
+
+      spec: {
+        owner: 'guest',
+        type: 'service',
+        lifecycle: 'production',
+      },
+    };
+    const apis = ApiRegistry.with(
+      scmIntegrationsApiRef,
+      ScmIntegrationsApi.fromConfig(
+        new ConfigReader({
+          integrations: {},
+        }),
+      ),
+    );
+
+    const { getByText } = await renderInTestApp(
+      <ApiProvider apis={apis}>
+        <EntityProvider entity={entity}>
+          <EntityOrphanWarning />
+        </EntityProvider>
+      </ApiProvider>,
+    );
+    expect(
+      getByText(
+        'This entity is not referenced by any location and is therefore not receiving updates. Click here to unregister.',
+      ),
+    ).toBeInTheDocument();
+  });
+
+  it('does not render EntityOrphanWarning if the entity is not orphan', async () => {
+    const entity = {
+      apiVersion: 'v1',
+      kind: 'Component',
+      metadata: {
+        name: 'software',
+        description: 'This is the description',
+      },
+
+      spec: {
+        owner: 'guest',
+        type: 'service',
+        lifecycle: 'production',
+      },
+    };
+    const apis = ApiRegistry.with(
+      scmIntegrationsApiRef,
+      ScmIntegrationsApi.fromConfig(
+        new ConfigReader({
+          integrations: {},
+        }),
+      ),
+    );
+
+    const { queryByText } = await renderInTestApp(
+      <ApiProvider apis={apis}>
+        <EntityProvider entity={entity}>
+          <EntityOrphanWarning />
+        </EntityProvider>
+      </ApiProvider>,
+    );
+    expect(
+      queryByText(
+        'This entity is not referenced by any location and is therefore not receiving updates. Click here to unregister.',
+      ),
+    ).not.toBeInTheDocument();
+  });
+});
@@ -0,0 +1,57 @@
+/*
+ * Copyright 2021 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { useEntity } from '@backstage/plugin-catalog-react';
+import { Alert } from '@material-ui/lab';
+import React, { useState } from 'react';
+import { useNavigate } from 'react-router';
+import { UnregisterEntityDialog } from '../UnregisterEntityDialog/UnregisterEntityDialog';
+
+/**
+ * Displays a warning alert if the entity is marked as orphan with the ability to delete said entity.
+ */
+export const EntityOrphanWarning = () => {
+  const navigate = useNavigate();
+  const [confirmationDialogOpen, setConfirmationDialogOpen] = useState(false);
+
+  const { entity } = useEntity();
+  if (
+    !entity.metadata?.annotations ||
+    entity.metadata?.annotations['backstage.io/orphan'] !== 'true'
+  ) {
+    return null;
+  }
+
+  const cleanUpAfterRemoval = async () => {
+    setConfirmationDialogOpen(false);
+    navigate('/');
+  };
+
+  return (
+    <>
+      <Alert severity="warning" onClick={() => setConfirmationDialogOpen(true)}>
+        This entity is not referenced by any location and is therefore not
+        receiving updates. Click here to unregister.
+      </Alert>
+      <UnregisterEntityDialog
+        open={confirmationDialogOpen}
+        entity={entity!}
+        onConfirm={cleanUpAfterRemoval}
+        onClose={() => setConfirmationDialogOpen(false)}
+      />
+    </>
+  );
+};
@@ -0,0 +1,17 @@
+/*
+ * Copyright 2021 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export { EntityOrphanWarning } from './EntityOrphanWarning';
@@ -35,3 +35,4 @@ export {
  EntityLinksCard,
  EntitySystemDiagramCard,
 } from './plugin';
+export * from './components/EntityOrphanWarning';