Added catalog-model support for dependsOn to Component and dependencyOf to Resource. Updated relevant relationship generator entity processors, and system diagram support.

Signed-off-by: Jonah Grimes <jonah.grimes@gmail.com>

packages/catalog-model/examples/components/artist-lookup-component.yaml

@@ -32,4 +32,6 @@ spec:
   type: service
   lifecycle: experimental
   owner: team-a
+  dependsOn:
+    - artists-db
   system: artist-engagement-portal

packages/catalog-model/src/kinds/ComponentEntityV1alpha1.test.ts

@@ -36,6 +36,7 @@ describe('ComponentV1alpha1Validator', () => {
         subcomponentOf: 'monolith',
         providesApis: ['api-0'],
         consumesApis: ['api-0'],
+        dependsOn: ['resource-0'],
         system: 'system',
       },
     };
@@ -160,6 +161,26 @@ describe('ComponentV1alpha1Validator', () => {
     await expect(validator.check(entity)).resolves.toBe(true);
   });
 
+  it('accepts missing dependsOn', async () => {
+    delete (entity as any).spec.dependsOn;
+    await expect(validator.check(entity)).resolves.toBe(true);
+  });
+
+  it('rejects empty dependsOn', async () => {
+    (entity as any).spec.dependsOn = [''];
+    await expect(validator.check(entity)).rejects.toThrow(/dependsOn/);
+  });
+
+  it('rejects undefined dependsOn', async () => {
+    (entity as any).spec.dependsOn = [undefined];
+    await expect(validator.check(entity)).rejects.toThrow(/dependsOn/);
+  });
+
+  it('accepts no dependsOn', async () => {
+    (entity as any).spec.dependsOn = [];
+    await expect(validator.check(entity)).resolves.toBe(true);
+  });
+
   it('accepts missing system', async () => {
     delete (entity as any).spec.system;
     await expect(validator.check(entity)).resolves.toBe(true);

packages/catalog-model/src/kinds/ComponentEntityV1alpha1.ts

@@ -34,6 +34,7 @@ export interface ComponentEntityV1alpha1 extends Entity {
     subcomponentOf?: string;
     providesApis?: string[];
     consumesApis?: string[];
+    dependsOn?: string[];
     system?: string;
   };
 }

packages/catalog-model/src/kinds/ResourceEntityV1alpha1.test.ts

@@ -32,6 +32,7 @@ describe('ResourceV1alpha1Validator', () => {
       spec: {
         type: 'database',
         owner: 'me',
+        dependencyOf: ['component-0'],
         system: 'system',
       },
     };
@@ -86,6 +87,26 @@ describe('ResourceV1alpha1Validator', () => {
     await expect(validator.check(entity)).rejects.toThrow(/owner/);
   });
 
+  it('accepts missing dependencyOf', async () => {
+    delete (entity as any).spec.dependencyOf;
+    await expect(validator.check(entity)).resolves.toBe(true);
+  });
+
+  it('rejects empty dependencyOf', async () => {
+    (entity as any).spec.dependencyOf = [''];
+    await expect(validator.check(entity)).rejects.toThrow(/dependencyOf/);
+  });
+
+  it('rejects undefined dependencyOf', async () => {
+    (entity as any).spec.dependencyOf = [undefined];
+    await expect(validator.check(entity)).rejects.toThrow(/dependencyOf/);
+  });
+
+  it('accepts no dependencyOf', async () => {
+    (entity as any).spec.dependencyOf = [];
+    await expect(validator.check(entity)).resolves.toBe(true);
+  });
+
   it('accepts missing system', async () => {
     delete (entity as any).spec.system;
     await expect(validator.check(entity)).resolves.toBe(true);

packages/catalog-model/src/kinds/ResourceEntityV1alpha1.ts

@@ -30,6 +30,7 @@ export interface ResourceEntityV1alpha1 extends Entity {
   spec: {
     type: string;
     owner: string;
+    dependencyOf?: string[];
     system?: string;
   };
 }

packages/catalog-model/src/schema/kinds/Component.v1alpha1.schema.json

@@ -84,6 +84,14 @@
                 "type": "string",
                 "minLength": 1
               }
+            },
+            "dependsOn": {
+              "type": "array",
+              "description": "An array of entity references to the resources that the component depends on.",
+              "items": {
+                "type": "string",
+                "minLength": 1
+              }
             }
           }
         }

packages/catalog-model/src/schema/kinds/Resource.v1alpha1.schema.json

@@ -47,6 +47,14 @@
               "examples": ["artist-relations-team", "user:john.johnson"],
               "minLength": 1
             },
+            "dependencyOf": {
+              "type": "array",
+              "description": "An array of entity references to the components that the resource is a dependency of.",
+              "items": {
+                "type": "string",
+                "minLength": 1
+              }
+            },
             "system": {
               "type": "string",
               "description": "An entity reference to the system that the resource belongs to.",

plugins/catalog-backend/src/ingestion/processors/BuiltinKindsEntityProcessor.test.ts

@@ -45,13 +45,14 @@ describe('BuiltinKindsEntityProcessor', () => {
           lifecycle: 'l',
           providesApis: ['b'],
           consumesApis: ['c'],
+          dependsOn: ['r'],
           system: 's',
         },
       };
 
       await processor.postProcessEntity(entity, location, emit);
 
-      expect(emit).toBeCalledTimes(10);
+      expect(emit).toBeCalledTimes(12);
       expect(emit).toBeCalledWith({
         type: 'relation',
         relation: {
@@ -100,6 +101,22 @@ describe('BuiltinKindsEntityProcessor', () => {
           target: { kind: 'API', namespace: 'default', name: 'c' },
         },
       });
+      expect(emit).toBeCalledWith({
+        type: 'relation',
+        relation: {
+          source: { kind: 'Resource', namespace: 'default', name: 'r' },
+          type: 'dependencyOf',
+          target: { kind: 'Component', namespace: 'default', name: 'n' },
+        },
+      });
+      expect(emit).toBeCalledWith({
+        type: 'relation',
+        relation: {
+          source: { kind: 'Component', namespace: 'default', name: 'n' },
+          type: 'dependsOn',
+          target: { kind: 'Resource', namespace: 'default', name: 'r' },
+        },
+      });
       expect(emit).toBeCalledWith({
         type: 'relation',
         relation: {
@@ -193,13 +210,14 @@ describe('BuiltinKindsEntityProcessor', () => {
         spec: {
           type: 'database',
           owner: 'o',
+          dependencyOf: ['c'],
           system: 's',
         },
       };
 
       await processor.postProcessEntity(entity, location, emit);
 
-      expect(emit).toBeCalledTimes(4);
+      expect(emit).toBeCalledTimes(6);
       expect(emit).toBeCalledWith({
         type: 'relation',
         relation: {
@@ -216,6 +234,22 @@ describe('BuiltinKindsEntityProcessor', () => {
           target: { kind: 'Group', namespace: 'default', name: 'o' },
         },
       });
+      expect(emit).toBeCalledWith({
+        type: 'relation',
+        relation: {
+          source: { kind: 'Resource', namespace: 'default', name: 'n' },
+          type: 'dependencyOf',
+          target: { kind: 'Component', namespace: 'default', name: 'c' },
+        },
+      });
+      expect(emit).toBeCalledWith({
+        type: 'relation',
+        relation: {
+          source: { kind: 'Component', namespace: 'default', name: 'c' },
+          type: 'dependsOn',
+          target: { kind: 'Resource', namespace: 'default', name: 'n' },
+        },
+      });
       expect(emit).toBeCalledWith({
         type: 'relation',
         relation: {

plugins/catalog-backend/src/ingestion/processors/BuiltinKindsEntityProcessor.ts

@@ -32,6 +32,8 @@ import {
   RELATION_API_PROVIDED_BY,
   RELATION_CHILD_OF,
   RELATION_CONSUMES_API,
+  RELATION_DEPENDENCY_OF,
+  RELATION_DEPENDS_ON,
   RELATION_HAS_MEMBER,
   RELATION_HAS_PART,
   RELATION_MEMBER_OF,
@@ -146,6 +148,12 @@ export class BuiltinKindsEntityProcessor implements CatalogProcessor {
         RELATION_CONSUMES_API,
         RELATION_API_CONSUMED_BY,
       );
+      doEmit(
+        component.spec.dependsOn,
+        { defaultKind: 'Resource', defaultNamespace: selfRef.namespace },
+        RELATION_DEPENDS_ON,
+        RELATION_DEPENDENCY_OF,
+      );
       doEmit(
         component.spec.system,
         { defaultKind: 'System', defaultNamespace: selfRef.namespace },
@@ -186,6 +194,12 @@ export class BuiltinKindsEntityProcessor implements CatalogProcessor {
         RELATION_OWNED_BY,
         RELATION_OWNER_OF,
       );
+      doEmit(
+        resource.spec.dependencyOf,
+        { defaultKind: 'Component', defaultNamespace: selfRef.namespace },
+        RELATION_DEPENDENCY_OF,
+        RELATION_DEPENDS_ON,
+      );
       doEmit(
         resource.spec.system,
         { defaultKind: 'System', defaultNamespace: selfRef.namespace },

plugins/catalog/src/components/SystemDiagramCard/SystemDiagramCard.tsx

@@ -16,6 +16,7 @@
 
 import {
   Entity,
+  RELATION_DEPENDS_ON,
   RELATION_PROVIDES_API,
   RELATION_PART_OF,
   serializeEntityRef,
@@ -124,7 +125,6 @@ export function SystemDiagramCard() {
         catalogItem,
         RELATION_PROVIDES_API,
       );
-
       catalogItemRelations_providesApi.forEach(foundRelation =>
         systemEdges.push({
           from: simplifiedEntityName(catalogItem),
@@ -132,6 +132,18 @@ export function SystemDiagramCard() {
           label: 'provides API',
         }),
       );
+
+      const catalogItemRelations_dependsOn = getEntityRelations(
+        catalogItem,
+        RELATION_DEPENDS_ON,
+      );
+      catalogItemRelations_dependsOn.forEach(foundRelation =>
+        systemEdges.push({
+          from: simplifiedEntityName(catalogItem),
+          to: simplifiedEntityName(foundRelation),
+          label: 'depends on',
+        }),
+      );
     }
   }