Merge pull request #9548 from backstage/jhaals/compareEntityToRef

catalog-model: deprecate compareEntityToRef

.changeset/fair-emus-check.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-catalog': patch
+---
+
+Replaced use of deprecated `compareEntityToRef` utility.

.changeset/fair-eyes-collect.md

@@ -0,0 +1,5 @@
+---
+'@backstage/catalog-model': patch
+---
+
+Deprecated `compareEntityToRef` due to low usage and provided value.

packages/catalog-model/api-report.md

@@ -66,7 +66,7 @@ export class CommonValidatorFunctions {
   static isValidUrl(value: unknown): boolean;
 }
 
-// @public
+// @public @deprecated
 export function compareEntityToRef(
   entity: Entity,
   ref: EntityRef | EntityName,

packages/catalog-model/src/entity/ref.ts

@@ -245,6 +245,7 @@ export function stringifyEntityRef(
  * @param context - An optional context of default kind and namespace, that apply
  *                to the ref if given
  * @returns True if matching, false otherwise
+ * @deprecated compare using stringifyEntityRef instead.
  */
 export function compareEntityToRef(
   entity: Entity,

plugins/catalog/src/components/EntityProcessingErrorsPanel/EntityProcessingErrorsPanel.tsx

@@ -19,7 +19,6 @@ import {
   AlphaEntity,
   stringifyEntityRef,
   EntityStatusItem,
-  compareEntityToRef,
 } from '@backstage/catalog-model';
 import {
   catalogApiRef,
@@ -110,10 +109,8 @@ export const EntityProcessingErrorsPanel = () => {
     <>
       {value.items.map((ancestorError, index) => (
         <Box key={index} mb={1}>
-          {!compareEntityToRef(
-            entity,
-            stringifyEntityRef(ancestorError.entity),
-          ) && (
+          {stringifyEntityRef(entity) !==
+            stringifyEntityRef(ancestorError.entity) && (
             <Box p={1}>
               The error below originates from{' '}
               <EntityRefLink entityRef={ancestorError.entity} />