feat: implement relations plugin

dweber019 · Mar 24, 2024 · 666e5ab · 666e5ab
1 parent 7830d8d
commit 666e5ab
Show file tree

Hide file tree

Showing 60 changed files with 2,105 additions and 88 deletions.
diff --git a/.changeset/poor-humans-agree.md b/.changeset/poor-humans-agree.md
@@ -0,0 +1,6 @@
+---
+'@dweber019/backstage-plugin-relations-processor': patch
+'@dweber019/backstage-plugin-relations': patch
+---
+
+Inital release of relations plugin.
diff --git a/app-config.yaml b/app-config.yaml
@@ -66,7 +66,7 @@ scaffolder:
 
 catalog:
   rules:
-    - allow: [Component, System, API, Resource, Location, User, Group]
+    - allow: [Component, System, API, Resource, Location, Group, User]
   locations:
     # Local example data, file locations are relative to the backend process, typically `packages/backend`
     - type: file
@@ -88,9 +88,43 @@ catalog:
     - type: file
       target: ../../plugins/accentuate-backend/examples/all.yaml
 
+    - type: file
+      target: ../../plugins/relations-processor/examples/all.yaml
+
 spectralLinter:
   openApiRulesetUrl: https://gist.githubusercontent.com/dweber019/a368819668a76363849db6378792e907/raw/backstage-spectral-linter-openapi-ruleset.yaml
   asyncApiRulesetUrl: https://gist.githubusercontent.com/dweber019/a368819668a76363849db6378792e907/raw/backstage-spectral-linter-asyncapi-ruleset.yaml
 
 accentuate:
   allowedKinds: ['User', 'Group', 'Component', 'Resource', 'System', 'Domain']
+
+relationsProcessor:
+  relations:
+    - sourceKind: component
+      sourceType:
+      targetKinds:
+        - user
+      attribute: applicationOwner
+      multi: false
+      pairs:
+      - incoming: applicationOwnerOf
+        outgoing: applicationOwnerBy
+      - incoming: ownerOf
+        outgoing: ownedBy
+    - sourceKind: group
+      targetKinds:
+        - user
+      attribute: productOwner
+      multi: false
+      pairs:
+      - incoming: productOwnerOf
+        outgoing: productOwnerBy
+    - sourceKind: resource
+      targetKinds:
+        - user
+        - group
+      attribute: supporter
+      multi: true
+      pairs:
+      - incoming: supporterOf
+        outgoing: supportedBy
diff --git a/packages/app/package.json b/packages/app/package.json
@@ -35,6 +35,7 @@
     "@dweber019/backstage-plugin-api-docs-module-wsdl": "^0.0.5",
     "@dweber019/backstage-plugin-api-docs-spectral-linter": "^0.2.11",
     "@dweber019/backstage-plugin-endoflife": "^0.0.3",
+    "@dweber019/backstage-plugin-relations": "0.0.0",
     "@dweber019/backstage-plugin-tips": "^0.0.8",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",

diff --git a/packages/app/src/App.tsx b/packages/app/src/App.tsx
@@ -44,7 +44,7 @@ import { Root } from './components/Root';
 import { AlertDisplay, OAuthRequestDialog } from '@backstage/core-components';
 import { createApp } from '@backstage/app-defaults';
 import { AppRouter, FlatRoutes } from '@backstage/core-app-api';
-import { CatalogGraphPage } from '@backstage/plugin-catalog-graph';
+import { RelationsCatalogGraphPage } from '@dweber019/backstage-plugin-relations';
 import { RequirePermission } from '@backstage/plugin-permission-react';
 import { catalogEntityCreatePermission } from '@backstage/plugin-catalog-common/alpha';
 import { AccentuatePage } from '@dweber019/backstage-plugin-accentuate';
@@ -103,7 +103,7 @@ const routes = (
       {searchPage}
     </Route>
     <Route path="/settings" element={<UserSettingsPage />} />
-    <Route path="/catalog-graph" element={<CatalogGraphPage />} />
+    <Route path="/catalog-graph" element={<RelationsCatalogGraphPage />} />
     <Route path="/accentuate" element={<AccentuatePage />} />
   </FlatRoutes>
 );

diff --git a/packages/app/src/components/catalog/EntityPage.tsx b/packages/app/src/components/catalog/EntityPage.tsx
@@ -59,6 +59,11 @@ import {
   isEndOfLifeAvailable,
 } from '@dweber019/backstage-plugin-endoflife';
 import { EntityTipsDialog } from '@dweber019/backstage-plugin-tips';
+import {
+  EntityRelationsCard,
+  EntityRelationsCatalogGraphCard,
+} from '@dweber019/backstage-plugin-relations';
+import { relationLabels } from './relationLabels';
 import {
   EntityAccentuateInfo,
   isAccentuateEnabled,
@@ -135,13 +140,16 @@ const overviewContent = (
       <EntityAboutCard variant="gridItem" />
     </Grid>
     <Grid item md={6} xs={12}>
-      <EntityCatalogGraphCard variant="gridItem" height={400} />
+      <EntityRelationsCatalogGraphCard variant="gridItem" height={400} />
     </Grid>
 
-    <Grid item md={4} xs={12}>
+    <Grid item md={6} xs={12}>
       <EntityLinksCard />
     </Grid>
-    <Grid item md={8} xs={12}>
+    <Grid item md={6} xs={12}>
+      <EntityRelationsCard />
+    </Grid>
+    <Grid item md={6} xs={12}>
       <EntityHasSubcomponentsCard variant="gridItem" />
     </Grid>
   </Grid>
@@ -270,7 +278,7 @@ const apiPage = (
           <EntityAboutCard />
         </Grid>
         <Grid item md={6} xs={12}>
-          <EntityCatalogGraphCard variant="gridItem" height={400} />
+          <EntityRelationsCatalogGraphCard variant="gridItem" height={400} />
         </Grid>
         <Grid item md={4} xs={12}>
           <EntityLinksCard />
@@ -315,6 +323,16 @@ const userPage = (
         <Grid item xs={12} md={6}>
           <EntityOwnershipCard variant="gridItem" />
         </Grid>
+        <Grid item md={6} xs={12}>
+          <EntityRelationsCatalogGraphCard
+            variant="gridItem"
+            height={400}
+            unidirectional={false}
+          />
+        </Grid>
+        <Grid item md={6} xs={12}>
+          <EntityRelationsCard relations={relationLabels} />
+        </Grid>
       </Grid>
     </EntityLayout.Route>
   </EntityLayout>
@@ -331,6 +349,12 @@ const groupPage = (
         <Grid item xs={12} md={6}>
           <EntityOwnershipCard variant="gridItem" />
         </Grid>
+        <Grid item md={6} xs={12}>
+          <EntityRelationsCatalogGraphCard variant="gridItem" height={400} />
+        </Grid>
+        <Grid item md={6} xs={12}>
+          <EntityRelationsCard />
+        </Grid>
         <Grid item xs={12} md={6}>
           <EntityMembersListCard />
         </Grid>
@@ -351,7 +375,7 @@ const systemPage = (
           <EntityAboutCard variant="gridItem" />
         </Grid>
         <Grid item md={6} xs={12}>
-          <EntityCatalogGraphCard variant="gridItem" height={400} />
+          <EntityRelationsCatalogGraphCard variant="gridItem" height={400} />
         </Grid>
         <Grid item md={4} xs={12}>
           <EntityLinksCard />
@@ -398,7 +422,7 @@ const domainPage = (
           <EntityAboutCard variant="gridItem" />
         </Grid>
         <Grid item md={6} xs={12}>
-          <EntityCatalogGraphCard variant="gridItem" height={400} />
+          <EntityRelationsCatalogGraphCard variant="gridItem" height={400} />
         </Grid>
         <Grid item md={6}>
           <EntityHasSystemsCard variant="gridItem" />

diff --git a/packages/app/src/components/catalog/relationLabels.ts b/packages/app/src/components/catalog/relationLabels.ts
@@ -0,0 +1,26 @@
+export const relationLabels = [
+  {
+    name: 'applicationOwnerOf',
+    label: 'Application owner of',
+  },
+  {
+    name: 'applicationOwnerBy',
+    label: 'Application owner',
+  },
+  {
+    name: 'productOwnerOf',
+    label: 'Product owner of',
+  },
+  {
+    name: 'productOwnerBy',
+    label: 'Product owner',
+  },
+  {
+    name: 'supporterOf',
+    label: 'Supporter of',
+  },
+  {
+    name: 'supporterBy',
+    label: 'Supporter',
+  },
+];
diff --git a/packages/backend/package.json b/packages/backend/package.json
@@ -42,6 +42,7 @@
     "@dweber019/backstage-plugin-accentuate-backend": "^0.0.0",
     "@dweber019/backstage-plugin-api-docs-module-wsdl-backend": "^0.0.7",
     "@dweber019/backstage-plugin-endoflife-backend": "^0.0.2",
+    "@dweber019/backstage-plugin-relations-backend": "0.0.0",
     "app": "link:../app",
     "better-sqlite3": "^9.0.0",
     "dockerode": "^3.3.1",

diff --git a/packages/backend/src/plugins/catalog.ts b/packages/backend/src/plugins/catalog.ts
@@ -17,6 +17,7 @@ import { CatalogBuilder } from '@backstage/plugin-catalog-backend';
 import { ScaffolderEntitiesProcessor } from '@backstage/plugin-catalog-backend-module-scaffolder-entity-model';
 import { Router } from 'express';
 import { PluginEnvironment } from '../types';
+import { RelationEntitiesProcessor } from '@dweber019/backstage-plugin-relations-backend';
 import { AccentuateEntitiesProcessor } from '@dweber019/backstage-plugin-accentuate-backend';
 
 export default async function createPlugin(
@@ -28,6 +29,7 @@ export default async function createPlugin(
   builder.addProcessor(
     await AccentuateEntitiesProcessor.fromEnv(envAccentuate),
   );
+  builder.addProcessor(RelationEntitiesProcessor.fromConfig(env));
   const { processingEngine, router } = await builder.build();
   await processingEngine.start();
   return router;

diff --git a/plugins/accentuate/package.json b/plugins/accentuate/package.json
@@ -53,8 +53,8 @@
     "@backstage/cli": "^0.26.1",
     "@backstage/dev-utils": "^1.0.29",
     "@backstage/test-utils": "^1.5.2",
-    "@testing-library/jest-dom": "^5.10.1",
-    "@testing-library/react": "^12.1.3",
+    "@testing-library/jest-dom": "^6.0.0",
+    "@testing-library/react": "^14.0.0",
     "@testing-library/user-event": "^14.0.0",
     "@types/lodash": "^4.17.0",
     "@types/node": "*",

diff --git a/plugins/api-docs-module-wsdl/package.json b/plugins/api-docs-module-wsdl/package.json
@@ -49,8 +49,9 @@
     "@backstage/dev-utils": "^1.0.29",
     "@backstage/plugin-api-docs": "^0.11.2",
     "@backstage/test-utils": "^1.5.2",
-    "@testing-library/jest-dom": "^5.16.4",
-    "@types/react": "^16.13.1 || ^17.0.0"
+    "@testing-library/jest-dom": "^6.0.0",
+    "@testing-library/react": "^14.0.0",
+    "@testing-library/user-event": "^14.0.0"
   },
   "files": [
     "dist"

diff --git a/plugins/api-docs-spectral-linter/package.json b/plugins/api-docs-spectral-linter/package.json
@@ -48,8 +48,8 @@
     "@backstage/cli": "^0.26.1",
     "@backstage/dev-utils": "^1.0.29",
     "@backstage/test-utils": "^1.5.2",
-    "@testing-library/jest-dom": "^5.10.1",
-    "@testing-library/react": "^12.1.3",
+    "@testing-library/jest-dom": "^6.0.0",
+    "@testing-library/react": "^14.0.0",
     "@testing-library/user-event": "^14.0.0",
     "@types/node": "*",
     "cross-fetch": "^3.1.5",

diff --git a/plugins/endoflife/package.json b/plugins/endoflife/package.json
@@ -49,8 +49,8 @@
     "@backstage/dev-utils": "^1.0.29",
     "@backstage/integration": "^1.9.1",
     "@backstage/test-utils": "^1.5.2",
-    "@testing-library/jest-dom": "^5.10.1",
-    "@testing-library/react": "^12.1.3",
+    "@testing-library/jest-dom": "^6.0.0",
+    "@testing-library/react": "^14.0.0",
     "@testing-library/user-event": "^14.0.0",
     "@types/luxon": "^3.4.0",
     "@types/node": "*",

diff --git a/plugins/relations-backend/.eslintrc.js b/plugins/relations-backend/.eslintrc.js
@@ -0,0 +1 @@
+module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);