catalog-backend: ignore relations when comparing entities

backstage · Dec 10, 2020 · 0e6298f · 0e6298f
1 parent 6349ea7
commit 0e6298f
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/.changeset/heavy-ducks-raise.md b/.changeset/heavy-ducks-raise.md
@@ -0,0 +1,5 @@
+---
+'@backstage/catalog-model': patch
+---
+
+Ignore relations when comparing entities. This stops the refresh loop from rewriting entities over and over.
diff --git a/packages/catalog-model/src/entity/util.ts b/packages/catalog-model/src/entity/util.ts
@@ -46,6 +46,10 @@ export function generateEntityEtag(): string {
  * are added or existing annotations were changed (since they are effectively
  * merged when doing updates).
  *
+ * Note that this comparison does NOT take state, relations or similar into
+ * account. It only compares the actual input entity data, i.e. metadata and
+ * spec.
+ *
  * @param previous The old state of the entity
  * @param next The new state of the entity
  */
@@ -76,6 +80,10 @@ export function entityHasChanges(previous: Entity, next: Entity): boolean {
   delete e1.metadata.annotations;
   delete e2.metadata.annotations;
 
+  // Remove things that we explicitly do not compare
+  delete e1.relations;
+  delete e2.relations;
+
   return !lodash.isEqual(e1, e2);
 }