catalog-model: Prefix annotations with ANNOTATION_

Signed-off-by: Johan Haals <johan.haals@gmail.com>

.changeset/tasty-taxis-dance.md

@@ -0,0 +1,14 @@
+---
+'@backstage/catalog-client': patch
+'@backstage/plugin-catalog': patch
+'@backstage/plugin-catalog-backend': patch
+'@backstage/plugin-catalog-backend-module-ldap': patch
+'@backstage/plugin-catalog-backend-module-msgraph': patch
+'@backstage/plugin-catalog-react': patch
+'@backstage/plugin-github-deployments': patch
+'@backstage/plugin-scaffolder-backend': patch
+'@backstage/plugin-todo': patch
+'@backstage/plugin-todo-backend': patch
+---
+
+Replaces use of deprecated catalog-model constants.

.changeset/twenty-dodos-rule.md

@@ -0,0 +1,6 @@
+---
+'@backstage/catalog-model': patch
+---
+
+Deprecates `EDIT_URL_ANNOTATION`, `LOCATION_ANNOTATION`, `ORIGIN_LOCATION_ANNOTATION`, `SOURCE_LOCATION_ANNOTATION`, `VIEW_URL_ANNOTATION`
+and replaces these constants all prefixed with ANNOTATION_ `ANNOTATION_EDIT_URL`, `ANNOTATION_LOCATION`, `ANNOTATION_ORIGIN_LOCATION`, `ANNOTATION_SOURCE_LOCATION`, `ANNOTATION_VIEW_URL`

packages/catalog-client/src/CatalogClient.ts

@@ -15,10 +15,10 @@
  */
 
 import {
+  ANNOTATION_LOCATION,
+  ANNOTATION_ORIGIN_LOCATION,
   Entity,
   EntityName,
-  LOCATION_ANNOTATION,
-  ORIGIN_LOCATION_ANNOTATION,
   parseEntityRef,
   stringifyEntityRef,
   stringifyLocationRef,
@@ -253,7 +253,7 @@ export class CatalogClient implements CatalogApi {
     options?: CatalogRequestOptions,
   ): Promise<Location | undefined> {
     const locationCompound =
-      entity.metadata.annotations?.[ORIGIN_LOCATION_ANNOTATION];
+      entity.metadata.annotations?.[ANNOTATION_ORIGIN_LOCATION];
     if (!locationCompound) {
       return undefined;
     }
@@ -274,7 +274,7 @@ export class CatalogClient implements CatalogApi {
     entity: Entity,
     options?: CatalogRequestOptions,
   ): Promise<Location | undefined> {
-    const locationCompound = entity.metadata.annotations?.[LOCATION_ANNOTATION];
+    const locationCompound = entity.metadata.annotations?.[ANNOTATION_LOCATION];
     if (!locationCompound) {
       return undefined;
     }

packages/catalog-model/api-report.md

@@ -13,6 +13,22 @@ export interface AlphaEntity extends Entity {
   status?: EntityStatus;
 }
 
+// @public
+export const ANNOTATION_EDIT_URL = 'backstage.io/edit-url';
+
+// @public
+export const ANNOTATION_LOCATION = 'backstage.io/managed-by-location';
+
+// @public
+export const ANNOTATION_ORIGIN_LOCATION =
+  'backstage.io/managed-by-origin-location';
+
+// @public
+export const ANNOTATION_SOURCE_LOCATION = 'backstage.io/source-location';
+
+// @public
+export const ANNOTATION_VIEW_URL = 'backstage.io/view-url';
+
 // @public
 interface ApiEntityV1alpha1 extends Entity {
   // (undocumented)
@@ -105,7 +121,7 @@ export { DomainEntityV1alpha1 };
 // @public
 export const domainEntityV1alpha1Validator: KindValidator;
 
-// @public
+// @public @deprecated
 export const EDIT_URL_ANNOTATION = 'backstage.io/edit-url';
 
 // @public
@@ -325,7 +341,7 @@ type Location_2 = {
 } & LocationSpec;
 export { Location_2 as Location };
 
-// @public
+// @public @deprecated
 export const LOCATION_ANNOTATION = 'backstage.io/managed-by-location';
 
 // @public
@@ -365,7 +381,7 @@ export class NoForeignRootFieldsEntityPolicy implements EntityPolicy {
   enforce(entity: Entity): Promise<Entity>;
 }
 
-// @public
+// @public @deprecated
 export const ORIGIN_LOCATION_ANNOTATION =
   'backstage.io/managed-by-origin-location';
 
@@ -489,7 +505,7 @@ export class SchemaValidEntityPolicy implements EntityPolicy {
   enforce(entity: Entity): Promise<Entity>;
 }
 
-// @public
+// @public @deprecated
 export const SOURCE_LOCATION_ANNOTATION = 'backstage.io/source-location';
 
 // @public
@@ -595,6 +611,6 @@ export type Validators = {
   isValidTag(value: unknown): boolean;
 };
 
-// @public
+// @public @deprecated
 export const VIEW_URL_ANNOTATION = 'backstage.io/view-url';
 ```

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

@@ -37,12 +37,28 @@ export const ENTITY_META_GENERATED_FIELDS = [
  * Annotation for linking to entity page from catalog pages.
  *
  * @public
+ * @deprecated use {@link ANNOTATION_VIEW_URL} instead.
  */
 export const VIEW_URL_ANNOTATION = 'backstage.io/view-url';
 
 /**
  * Annotation for linking to entity edit page from catalog pages.
  *
  * @public
+ * @deprecated use {@link ANNOTATION_EDIT_URL} instead.
  */
 export const EDIT_URL_ANNOTATION = 'backstage.io/edit-url';
+
+/**
+ * Annotation for linking to entity page from catalog pages.
+ *
+ * @public
+ */
+export const ANNOTATION_VIEW_URL = 'backstage.io/view-url';
+
+/**
+ * Annotation for linking to entity edit page from catalog pages.
+ *
+ * @public
+ */
+export const ANNOTATION_EDIT_URL = 'backstage.io/edit-url';

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

@@ -19,6 +19,8 @@ export {
   ENTITY_DEFAULT_NAMESPACE,
   ENTITY_META_GENERATED_FIELDS,
   VIEW_URL_ANNOTATION,
+  ANNOTATION_EDIT_URL,
+  ANNOTATION_VIEW_URL,
 } from './constants';
 export type {
   AlphaEntity,

packages/catalog-model/src/location/annotation.ts

@@ -17,17 +17,41 @@
 /**
  * Constant storing location annotation.
  *
- * @public */
+ * @public
+ * @deprecated use {@link ANNOTATION_LOCATION} instead.
+ * */
 export const LOCATION_ANNOTATION = 'backstage.io/managed-by-location';
 /**
  * Constant storing origin location annotation
  *
- * @public */
+ * @public
+ * @deprecated use {@link ANNOTATION_ORIGIN_LOCATION} instead.
+ */
 export const ORIGIN_LOCATION_ANNOTATION =
   'backstage.io/managed-by-origin-location';
 
 /**
  * Contant storing source location annotation
  *
- * @public */
+ * @public
+ * @deprecated use {@link ANNOTATION_SOURCE_LOCATION} instead.
+ * */
 export const SOURCE_LOCATION_ANNOTATION = 'backstage.io/source-location';
+
+/**
+ * Constant storing location annotation.
+ *
+ * @public */
+export const ANNOTATION_LOCATION = 'backstage.io/managed-by-location';
+/**
+ * Constant storing origin location annotation
+ *
+ * @public */
+export const ANNOTATION_ORIGIN_LOCATION =
+  'backstage.io/managed-by-origin-location';
+
+/**
+ * Contant storing source location annotation
+ *
+ * @public */
+export const ANNOTATION_SOURCE_LOCATION = 'backstage.io/source-location';

packages/catalog-model/src/location/helpers.ts

@@ -14,8 +14,9 @@
  * limitations under the License.
  */
 
+import { ANNOTATION_SOURCE_LOCATION } from '.';
 import { Entity, stringifyEntityRef } from '../entity';
-import { LOCATION_ANNOTATION, SOURCE_LOCATION_ANNOTATION } from './annotation';
+import { ANNOTATION_LOCATION } from './annotation';
 
 /**
  * Parses a string form location reference.
@@ -142,8 +143,8 @@ export function getEntitySourceLocation(entity: Entity): {
   target: string;
 } {
   const locationRef =
-    entity.metadata?.annotations?.[SOURCE_LOCATION_ANNOTATION] ??
-    entity.metadata?.annotations?.[LOCATION_ANNOTATION];
+    entity.metadata?.annotations?.[ANNOTATION_SOURCE_LOCATION] ??
+    entity.metadata?.annotations?.[ANNOTATION_LOCATION];
 
   if (!locationRef) {
     throw new Error(

packages/catalog-model/src/location/index.ts

@@ -15,6 +15,9 @@
  */
 
 export {
+  ANNOTATION_LOCATION,
+  ANNOTATION_ORIGIN_LOCATION,
+  ANNOTATION_SOURCE_LOCATION,
   LOCATION_ANNOTATION,
   ORIGIN_LOCATION_ANNOTATION,
   SOURCE_LOCATION_ANNOTATION,

plugins/catalog-backend-module-ldap/src/processors/LdapOrgEntityProvider.ts

@@ -15,9 +15,9 @@
  */
 
 import {
+  ANNOTATION_LOCATION,
+  ANNOTATION_ORIGIN_LOCATION,
   Entity,
-  LOCATION_ANNOTATION,
-  ORIGIN_LOCATION_ANNOTATION,
 } from '@backstage/catalog-model';
 import { Config } from '@backstage/config';
 import {
@@ -207,8 +207,8 @@ function withLocations(providerId: string, entity: Entity): Entity {
     {
       metadata: {
         annotations: {
-          [LOCATION_ANNOTATION]: location,
-          [ORIGIN_LOCATION_ANNOTATION]: location,
+          [ANNOTATION_LOCATION]: location,
+          [ANNOTATION_ORIGIN_LOCATION]: location,
         },
       },
     },

plugins/catalog-backend-module-msgraph/src/processors/MicrosoftGraphOrgEntityProvider.test.ts

@@ -15,9 +15,9 @@
  */
 import { getVoidLogger } from '@backstage/backend-common';
 import {
+  ANNOTATION_LOCATION,
+  ANNOTATION_ORIGIN_LOCATION,
   GroupEntity,
-  LOCATION_ANNOTATION,
-  ORIGIN_LOCATION_ANNOTATION,
   UserEntity,
 } from '@backstage/catalog-model';
 import { EntityProviderConnection } from '@backstage/plugin-catalog-backend';
@@ -162,8 +162,8 @@ describe('withLocations', () => {
         name: 'u1',
         annotations: {
           [MICROSOFT_GRAPH_USER_ID_ANNOTATION]: 'uid',
-          [LOCATION_ANNOTATION]: 'msgraph:test/uid',
-          [ORIGIN_LOCATION_ANNOTATION]: 'msgraph:test/uid',
+          [ANNOTATION_LOCATION]: 'msgraph:test/uid',
+          [ANNOTATION_ORIGIN_LOCATION]: 'msgraph:test/uid',
         },
       },
       spec: {

plugins/catalog-backend-module-msgraph/src/processors/MicrosoftGraphOrgEntityProvider.ts

@@ -15,9 +15,9 @@
  */
 
 import {
+  ANNOTATION_LOCATION,
+  ANNOTATION_ORIGIN_LOCATION,
   Entity,
-  LOCATION_ANNOTATION,
-  ORIGIN_LOCATION_ANNOTATION,
 } from '@backstage/catalog-model';
 import { Config } from '@backstage/config';
 import {
@@ -180,8 +180,8 @@ export function withLocations(providerId: string, entity: Entity): Entity {
     {
       metadata: {
         annotations: {
-          [LOCATION_ANNOTATION]: location,
-          [ORIGIN_LOCATION_ANNOTATION]: location,
+          [ANNOTATION_LOCATION]: location,
+          [ANNOTATION_ORIGIN_LOCATION]: location,
         },
       },
     },

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

@@ -15,14 +15,14 @@
  */
 
 import {
-  EDIT_URL_ANNOTATION,
+  ANNOTATION_EDIT_URL,
+  ANNOTATION_LOCATION,
+  ANNOTATION_ORIGIN_LOCATION,
+  ANNOTATION_SOURCE_LOCATION,
+  ANNOTATION_VIEW_URL,
   Entity,
   LocationSpec,
-  LOCATION_ANNOTATION,
-  ORIGIN_LOCATION_ANNOTATION,
-  SOURCE_LOCATION_ANNOTATION,
   stringifyLocationRef,
-  VIEW_URL_ANNOTATION,
 } from '@backstage/catalog-model';
 import { ScmIntegrationRegistry } from '@backstage/integration';
 import { identity, merge, pickBy } from 'lodash';
@@ -70,12 +70,12 @@ export class AnnotateLocationEntityProcessor implements CatalogProcessor {
         metadata: {
           annotations: pickBy(
             {
-              [LOCATION_ANNOTATION]: stringifyLocationRef(location),
-              [ORIGIN_LOCATION_ANNOTATION]:
+              [ANNOTATION_LOCATION]: stringifyLocationRef(location),
+              [ANNOTATION_ORIGIN_LOCATION]:
                 stringifyLocationRef(originLocation),
-              [VIEW_URL_ANNOTATION]: viewUrl,
-              [EDIT_URL_ANNOTATION]: editUrl,
-              [SOURCE_LOCATION_ANNOTATION]: sourceLocation,
+              [ANNOTATION_VIEW_URL]: viewUrl,
+              [ANNOTATION_EDIT_URL]: editUrl,
+              [ANNOTATION_SOURCE_LOCATION]: sourceLocation,
             },
             identity,
           ),

plugins/catalog-backend/src/ingestion/providers/GitHubOrgEntityProvider.ts

@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 import {
+  ANNOTATION_LOCATION,
+  ANNOTATION_ORIGIN_LOCATION,
   Entity,
-  LOCATION_ANNOTATION,
-  ORIGIN_LOCATION_ANNOTATION,
 } from '@backstage/catalog-model';
 import { Config } from '@backstage/config';
 import {
@@ -178,8 +178,8 @@ export function withLocations(
     {
       metadata: {
         annotations: {
-          [LOCATION_ANNOTATION]: location,
-          [ORIGIN_LOCATION_ANNOTATION]: location,
+          [ANNOTATION_LOCATION]: location,
+          [ANNOTATION_ORIGIN_LOCATION]: location,
         },
       },
     },