diff --git a/.changeset/fair-bees-join.md b/.changeset/fair-bees-join.md new file mode 100644 index 0000000000..671ce694da --- /dev/null +++ b/.changeset/fair-bees-join.md @@ -0,0 +1,5 @@ +--- +'@backstage/catalog-model': patch +--- + +Deprecates `ENTITY_DEFAULT_NAMESPACE` constant in favour of `DEFAULT_NAMESPACE`. diff --git a/.changeset/three-roses-swim.md b/.changeset/three-roses-swim.md new file mode 100644 index 0000000000..ae6ad44845 --- /dev/null +++ b/.changeset/three-roses-swim.md @@ -0,0 +1,18 @@ +--- +'@backstage/techdocs-common': patch +'@backstage/plugin-auth-backend': patch +'@backstage/plugin-badges': patch +'@backstage/plugin-badges-backend': patch +'@backstage/plugin-catalog': patch +'@backstage/plugin-catalog-backend': patch +'@backstage/plugin-catalog-graph': patch +'@backstage/plugin-catalog-react': patch +'@backstage/plugin-cost-insights': patch +'@backstage/plugin-ilert': patch +'@backstage/plugin-org': patch +'@backstage/plugin-pagerduty': patch +'@backstage/plugin-search': patch +'@backstage/plugin-techdocs-backend': patch +--- + +Replace use of deprecated `ENTITY_DEFAULT_NAMESPACE` constant with `DEFAULT_NAMESPACE`. diff --git a/packages/catalog-model/api-report.md b/packages/catalog-model/api-report.md index 655d01fef1..4b19c799d8 100644 --- a/packages/catalog-model/api-report.md +++ b/packages/catalog-model/api-report.md @@ -97,6 +97,9 @@ export { ComponentEntityV1alpha1 }; // @public export const componentEntityV1alpha1Validator: KindValidator; +// @public +export const DEFAULT_NAMESPACE = 'default'; + // @public export class DefaultNamespaceEntityPolicy implements EntityPolicy { constructor(namespace?: string); @@ -133,7 +136,7 @@ export type Entity = { relations?: EntityRelation[]; }; -// @public +// @public @deprecated export const ENTITY_DEFAULT_NAMESPACE = 'default'; // @public @deprecated diff --git a/packages/catalog-model/src/entity/constants.ts b/packages/catalog-model/src/entity/constants.ts index 4d0e6799be..6cef19cac9 100644 --- a/packages/catalog-model/src/entity/constants.ts +++ b/packages/catalog-model/src/entity/constants.ts @@ -18,9 +18,17 @@ * The namespace that entities without an explicit namespace fall into. * * @public + * @deprecated use {@link DEFAULT_NAMESPACE} instead. */ export const ENTITY_DEFAULT_NAMESPACE = 'default'; +/** + * The namespace that entities without an explicit namespace fall into. + * + * @public + */ +export const DEFAULT_NAMESPACE = 'default'; + /** * The keys of EntityMeta that are auto-generated. * diff --git a/packages/catalog-model/src/entity/index.ts b/packages/catalog-model/src/entity/index.ts index 49a6da5e0a..938bdb2b9b 100644 --- a/packages/catalog-model/src/entity/index.ts +++ b/packages/catalog-model/src/entity/index.ts @@ -17,6 +17,7 @@ export { EDIT_URL_ANNOTATION, ENTITY_DEFAULT_NAMESPACE, + DEFAULT_NAMESPACE, ENTITY_META_GENERATED_FIELDS, VIEW_URL_ANNOTATION, ANNOTATION_EDIT_URL, diff --git a/packages/techdocs-common/src/stages/publish/awsS3.test.ts b/packages/techdocs-common/src/stages/publish/awsS3.test.ts index 3e4c4c705b..357df73c8c 100644 --- a/packages/techdocs-common/src/stages/publish/awsS3.test.ts +++ b/packages/techdocs-common/src/stages/publish/awsS3.test.ts @@ -15,7 +15,7 @@ */ import { getVoidLogger } from '@backstage/backend-common'; -import { Entity, ENTITY_DEFAULT_NAMESPACE } from '@backstage/catalog-model'; +import { Entity, DEFAULT_NAMESPACE } from '@backstage/catalog-model'; import { ConfigReader } from '@backstage/config'; import express from 'express'; import request from 'supertest'; @@ -34,7 +34,7 @@ const getEntityRootDir = (entity: Entity) => { metadata: { namespace, name }, } = entity; - return path.join(rootDir, namespace || ENTITY_DEFAULT_NAMESPACE, kind, name); + return path.join(rootDir, namespace || DEFAULT_NAMESPACE, kind, name); }; const logger = getVoidLogger(); diff --git a/packages/techdocs-common/src/stages/publish/azureBlobStorage.test.ts b/packages/techdocs-common/src/stages/publish/azureBlobStorage.test.ts index e6fd45eed7..f1b660555e 100644 --- a/packages/techdocs-common/src/stages/publish/azureBlobStorage.test.ts +++ b/packages/techdocs-common/src/stages/publish/azureBlobStorage.test.ts @@ -15,7 +15,7 @@ */ import { getVoidLogger } from '@backstage/backend-common'; -import { Entity, ENTITY_DEFAULT_NAMESPACE } from '@backstage/catalog-model'; +import { Entity, DEFAULT_NAMESPACE } from '@backstage/catalog-model'; import { ConfigReader } from '@backstage/config'; import express from 'express'; import request from 'supertest'; @@ -34,7 +34,7 @@ const getEntityRootDir = (entity: Entity) => { metadata: { namespace, name }, } = entity; - return path.join(rootDir, namespace || ENTITY_DEFAULT_NAMESPACE, kind, name); + return path.join(rootDir, namespace || DEFAULT_NAMESPACE, kind, name); }; const logger = getVoidLogger(); diff --git a/packages/techdocs-common/src/stages/publish/googleStorage.test.ts b/packages/techdocs-common/src/stages/publish/googleStorage.test.ts index ed35f2e445..87a38402d0 100644 --- a/packages/techdocs-common/src/stages/publish/googleStorage.test.ts +++ b/packages/techdocs-common/src/stages/publish/googleStorage.test.ts @@ -15,7 +15,7 @@ */ import { getVoidLogger } from '@backstage/backend-common'; -import { Entity, ENTITY_DEFAULT_NAMESPACE } from '@backstage/catalog-model'; +import { Entity, DEFAULT_NAMESPACE } from '@backstage/catalog-model'; import { ConfigReader } from '@backstage/config'; import express from 'express'; import request from 'supertest'; @@ -34,7 +34,7 @@ const getEntityRootDir = (entity: Entity) => { metadata: { namespace, name }, } = entity; - return path.join(rootDir, namespace || ENTITY_DEFAULT_NAMESPACE, kind, name); + return path.join(rootDir, namespace || DEFAULT_NAMESPACE, kind, name); }; const logger = getVoidLogger(); diff --git a/packages/techdocs-common/src/stages/publish/helpers.test.ts b/packages/techdocs-common/src/stages/publish/helpers.test.ts index 6245898586..7acdb47ea7 100644 --- a/packages/techdocs-common/src/stages/publish/helpers.test.ts +++ b/packages/techdocs-common/src/stages/publish/helpers.test.ts @@ -16,7 +16,7 @@ import mockFs from 'mock-fs'; import * as os from 'os'; import * as path from 'path'; -import { Entity, ENTITY_DEFAULT_NAMESPACE } from '@backstage/catalog-model'; +import { Entity, DEFAULT_NAMESPACE } from '@backstage/catalog-model'; import { getStaleFiles, getFileTreeRecursively, @@ -189,7 +189,7 @@ describe('getCloudPathForLocalPath', () => { localPath, ); expect(remoteBucket).toBe( - `${ENTITY_DEFAULT_NAMESPACE}/component/backstage/${localPath}`, + `${DEFAULT_NAMESPACE}/component/backstage/${localPath}`, ); }); diff --git a/packages/techdocs-common/src/stages/publish/helpers.ts b/packages/techdocs-common/src/stages/publish/helpers.ts index cbecee51bc..decefae187 100644 --- a/packages/techdocs-common/src/stages/publish/helpers.ts +++ b/packages/techdocs-common/src/stages/publish/helpers.ts @@ -13,7 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -import { Entity, ENTITY_DEFAULT_NAMESPACE } from '@backstage/catalog-model'; +import { Entity, DEFAULT_NAMESPACE } from '@backstage/catalog-model'; import mime from 'mime-types'; import path from 'path'; import createLimiter from 'p-limit'; @@ -188,9 +188,9 @@ export const getCloudPathForLocalPath = ( const relativeFilePathPosix = localPath.split(path.sep).join(path.posix.sep); // The / delimiter is intentional since it represents the cloud storage and not the local file system. - const entityRootDir = `${ - entity.metadata?.namespace ?? ENTITY_DEFAULT_NAMESPACE - }/${entity.kind}/${entity.metadata.name}`; + const entityRootDir = `${entity.metadata?.namespace ?? DEFAULT_NAMESPACE}/${ + entity.kind + }/${entity.metadata.name}`; const relativeFilePathTriplet = `${entityRootDir}/${relativeFilePathPosix}`; diff --git a/packages/techdocs-common/src/stages/publish/openStackSwift.test.ts b/packages/techdocs-common/src/stages/publish/openStackSwift.test.ts index ef06e26cfa..b240ce73da 100644 --- a/packages/techdocs-common/src/stages/publish/openStackSwift.test.ts +++ b/packages/techdocs-common/src/stages/publish/openStackSwift.test.ts @@ -18,7 +18,7 @@ import { getVoidLogger } from '@backstage/backend-common'; import { Entity, EntityName, - ENTITY_DEFAULT_NAMESPACE, + DEFAULT_NAMESPACE, } from '@backstage/catalog-model'; import { ConfigReader } from '@backstage/config'; import express from 'express'; @@ -59,7 +59,7 @@ const getEntityRootDir = (entity: Entity) => { metadata: { namespace, name }, } = entity; - return path.join(rootDir, namespace || ENTITY_DEFAULT_NAMESPACE, kind, name); + return path.join(rootDir, namespace || DEFAULT_NAMESPACE, kind, name); }; const getPosixEntityRootDir = (entity: Entity) => { @@ -70,7 +70,7 @@ const getPosixEntityRootDir = (entity: Entity) => { return path.posix.join( '/rootDir', - namespace || ENTITY_DEFAULT_NAMESPACE, + namespace || DEFAULT_NAMESPACE, kind, name, ); diff --git a/plugins/auth-backend/src/lib/oauth/OAuthAdapter.ts b/plugins/auth-backend/src/lib/oauth/OAuthAdapter.ts index 75a3605483..07611ddb9c 100644 --- a/plugins/auth-backend/src/lib/oauth/OAuthAdapter.ts +++ b/plugins/auth-backend/src/lib/oauth/OAuthAdapter.ts @@ -18,7 +18,7 @@ import express, { CookieOptions } from 'express'; import crypto from 'crypto'; import { URL } from 'url'; import { - ENTITY_DEFAULT_NAMESPACE, + DEFAULT_NAMESPACE, parseEntityRef, stringifyEntityRef, } from '@backstage/catalog-model'; @@ -271,7 +271,7 @@ export class OAuthAdapter implements AuthProviderRouteHandlers { const userEntityRef = stringifyEntityRef( parseEntityRef(identity.id, { defaultKind: 'user', - defaultNamespace: ENTITY_DEFAULT_NAMESPACE, + defaultNamespace: DEFAULT_NAMESPACE, }), ); const token = await this.options.tokenIssuer.issueToken({ diff --git a/plugins/auth-backend/src/providers/prepareBackstageIdentityResponse.ts b/plugins/auth-backend/src/providers/prepareBackstageIdentityResponse.ts index f3b234c08e..5a4e0895d9 100644 --- a/plugins/auth-backend/src/providers/prepareBackstageIdentityResponse.ts +++ b/plugins/auth-backend/src/providers/prepareBackstageIdentityResponse.ts @@ -15,7 +15,7 @@ */ import { - ENTITY_DEFAULT_NAMESPACE, + DEFAULT_NAMESPACE, parseEntityRef, stringifyEntityRef, } from '@backstage/catalog-model'; @@ -44,7 +44,7 @@ export function prepareBackstageIdentityResponse( const userEntityRef = stringifyEntityRef( parseEntityRef(sub, { defaultKind: 'user', - defaultNamespace: ENTITY_DEFAULT_NAMESPACE, + defaultNamespace: DEFAULT_NAMESPACE, }), ); return { diff --git a/plugins/badges-backend/src/badges.ts b/plugins/badges-backend/src/badges.ts index 9e4087e334..78108de080 100644 --- a/plugins/badges-backend/src/badges.ts +++ b/plugins/badges-backend/src/badges.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { ENTITY_DEFAULT_NAMESPACE } from '@backstage/catalog-model'; +import { DEFAULT_NAMESPACE } from '@backstage/catalog-model'; import { InputError } from '@backstage/errors'; import { Badge, BadgeContext, BadgeFactories } from './types'; @@ -24,9 +24,9 @@ function appTitle(context: BadgeContext): string { function entityUrl(context: BadgeContext): string { const e = context.entity!; - const entityUri = `${e.metadata.namespace || ENTITY_DEFAULT_NAMESPACE}/${ - e.kind - }/${e.metadata.name}`; + const entityUri = `${e.metadata.namespace || DEFAULT_NAMESPACE}/${e.kind}/${ + e.metadata.name + }`; const catalogUrl = `${context.config.getString('app.baseUrl')}/catalog`; return `${catalogUrl}/${entityUri}`.toLowerCase(); } diff --git a/plugins/badges/src/api/BadgesClient.ts b/plugins/badges/src/api/BadgesClient.ts index 68714b2fa4..f63003dc90 100644 --- a/plugins/badges/src/api/BadgesClient.ts +++ b/plugins/badges/src/api/BadgesClient.ts @@ -16,7 +16,7 @@ import { generatePath } from 'react-router'; import { ResponseError } from '@backstage/errors'; -import { Entity, ENTITY_DEFAULT_NAMESPACE } from '@backstage/catalog-model'; +import { Entity, DEFAULT_NAMESPACE } from '@backstage/catalog-model'; import { BadgesApi, BadgeSpec } from './types'; import { DiscoveryApi, IdentityApi } from '@backstage/core-plugin-api'; @@ -63,7 +63,7 @@ export class BadgesClient implements BadgesApi { kind: entity.kind.toLocaleLowerCase('en-US'), namespace: entity.metadata.namespace?.toLocaleLowerCase('en-US') ?? - ENTITY_DEFAULT_NAMESPACE, + DEFAULT_NAMESPACE, name: entity.metadata.name, }; } diff --git a/plugins/catalog-backend/src/stitching/buildEntitySearch.test.ts b/plugins/catalog-backend/src/stitching/buildEntitySearch.test.ts index 58551a461f..173538f18f 100644 --- a/plugins/catalog-backend/src/stitching/buildEntitySearch.test.ts +++ b/plugins/catalog-backend/src/stitching/buildEntitySearch.test.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { Entity, ENTITY_DEFAULT_NAMESPACE } from '@backstage/catalog-model'; +import { Entity, DEFAULT_NAMESPACE } from '@backstage/catalog-model'; import { buildEntitySearch, mapToRows, traverse } from './buildEntitySearch'; describe('buildEntitySearch', () => { @@ -133,7 +133,7 @@ describe('buildEntitySearch', () => { { entity_id: 'eid', key: 'metadata.namespace', - value: ENTITY_DEFAULT_NAMESPACE, + value: DEFAULT_NAMESPACE, }, ]); }); @@ -157,7 +157,7 @@ describe('buildEntitySearch', () => { { entity_id: 'eid', key: 'metadata.namespace', - value: ENTITY_DEFAULT_NAMESPACE, + value: DEFAULT_NAMESPACE, }, { entity_id: 'eid', key: 'relations.t1', value: 'k:ns/a' }, { entity_id: 'eid', key: 'relations.t2', value: 'k:ns/b' }, diff --git a/plugins/catalog-backend/src/stitching/buildEntitySearch.ts b/plugins/catalog-backend/src/stitching/buildEntitySearch.ts index 84c6036013..d0506e8998 100644 --- a/plugins/catalog-backend/src/stitching/buildEntitySearch.ts +++ b/plugins/catalog-backend/src/stitching/buildEntitySearch.ts @@ -16,7 +16,7 @@ import { Entity, - ENTITY_DEFAULT_NAMESPACE, + DEFAULT_NAMESPACE, stringifyEntityRef, } from '@backstage/catalog-model'; import { InputError } from '@backstage/errors'; @@ -174,7 +174,7 @@ export function buildEntitySearch( // Namespace not specified has the default value "default", so we want to // match on that as well if (!entity.metadata.namespace) { - raw.push({ key: 'metadata.namespace', value: ENTITY_DEFAULT_NAMESPACE }); + raw.push({ key: 'metadata.namespace', value: DEFAULT_NAMESPACE }); } // Visit relations diff --git a/plugins/catalog-graph/dev/index.tsx b/plugins/catalog-graph/dev/index.tsx index b9da70c812..3ff9285a81 100644 --- a/plugins/catalog-graph/dev/index.tsx +++ b/plugins/catalog-graph/dev/index.tsx @@ -17,7 +17,7 @@ import { GetEntitiesResponse } from '@backstage/catalog-client'; import { Entity, EntityName, - ENTITY_DEFAULT_NAMESPACE, + DEFAULT_NAMESPACE, RELATION_API_CONSUMED_BY, RELATION_API_PROVIDED_BY, RELATION_CONSUMES_API, @@ -117,7 +117,7 @@ const entities = ( name, }, relations: relations.map(([type, k, n]) => ({ - target: { kind: k, name: n, namespace: ENTITY_DEFAULT_NAMESPACE }, + target: { kind: k, name: n, namespace: DEFAULT_NAMESPACE }, type, })), }; diff --git a/plugins/catalog-graph/src/components/EntityRelationsGraph/useEntityRelationNodesAndEdges.ts b/plugins/catalog-graph/src/components/EntityRelationsGraph/useEntityRelationNodesAndEdges.ts index 2f78fd9c17..b272abc654 100644 --- a/plugins/catalog-graph/src/components/EntityRelationsGraph/useEntityRelationNodesAndEdges.ts +++ b/plugins/catalog-graph/src/components/EntityRelationsGraph/useEntityRelationNodesAndEdges.ts @@ -14,7 +14,7 @@ * limitations under the License. */ import { - ENTITY_DEFAULT_NAMESPACE, + DEFAULT_NAMESPACE, stringifyEntityRef, } from '@backstage/catalog-model'; import { MouseEvent, useState } from 'react'; @@ -77,7 +77,7 @@ export function useEntityRelationNodesAndEdges({ title: entity.metadata?.title ?? undefined, kind: entity.kind, name: entity.metadata.name, - namespace: entity.metadata.namespace ?? ENTITY_DEFAULT_NAMESPACE, + namespace: entity.metadata.namespace ?? DEFAULT_NAMESPACE, focused, color: focused ? 'secondary' : 'primary', }; diff --git a/plugins/catalog-react/src/components/EntityRefLink/EntityRefLink.tsx b/plugins/catalog-react/src/components/EntityRefLink/EntityRefLink.tsx index 8120ececd2..f2c67f1087 100644 --- a/plugins/catalog-react/src/components/EntityRefLink/EntityRefLink.tsx +++ b/plugins/catalog-react/src/components/EntityRefLink/EntityRefLink.tsx @@ -17,7 +17,7 @@ import { Entity, EntityName, - ENTITY_DEFAULT_NAMESPACE, + DEFAULT_NAMESPACE, } from '@backstage/catalog-model'; import React, { forwardRef } from 'react'; import { entityRouteRef } from '../../routes'; @@ -66,8 +66,7 @@ export const EntityRefLink = forwardRef( const routeParams = { kind, - namespace: - namespace?.toLocaleLowerCase('en-US') ?? ENTITY_DEFAULT_NAMESPACE, + namespace: namespace?.toLocaleLowerCase('en-US') ?? DEFAULT_NAMESPACE, name, }; const formattedEntityRefTitle = formatEntityRefTitle(entityRef, { diff --git a/plugins/catalog-react/src/components/EntityRefLink/format.ts b/plugins/catalog-react/src/components/EntityRefLink/format.ts index 4787474c68..50e018c7ab 100644 --- a/plugins/catalog-react/src/components/EntityRefLink/format.ts +++ b/plugins/catalog-react/src/components/EntityRefLink/format.ts @@ -17,7 +17,7 @@ import { Entity, EntityName, - ENTITY_DEFAULT_NAMESPACE, + DEFAULT_NAMESPACE, } from '@backstage/catalog-model'; export function formatEntityRefTitle( @@ -39,7 +39,7 @@ export function formatEntityRefTitle( name = entityRef.name; } - if (namespace === ENTITY_DEFAULT_NAMESPACE) { + if (namespace === DEFAULT_NAMESPACE) { namespace = undefined; } diff --git a/plugins/catalog-react/src/components/InspectEntityDialog/components/AncestryPage.tsx b/plugins/catalog-react/src/components/InspectEntityDialog/components/AncestryPage.tsx index b27bbe3948..bf6c8971b0 100644 --- a/plugins/catalog-react/src/components/InspectEntityDialog/components/AncestryPage.tsx +++ b/plugins/catalog-react/src/components/InspectEntityDialog/components/AncestryPage.tsx @@ -16,7 +16,7 @@ import { Entity, - ENTITY_DEFAULT_NAMESPACE, + DEFAULT_NAMESPACE, stringifyEntityRef, } from '@backstage/catalog-model'; import { @@ -143,7 +143,7 @@ function CustomNode({ node }: DependencyGraphTypes.RenderNodeProps) { navigate( entityRoute({ kind: node.kind, - namespace: node.metadata.namespace || ENTITY_DEFAULT_NAMESPACE, + namespace: node.metadata.namespace || DEFAULT_NAMESPACE, name: node.metadata.name, }), ); diff --git a/plugins/catalog-react/src/hooks/useOwnUser.ts b/plugins/catalog-react/src/hooks/useOwnUser.ts index f49eb768d0..497f065f04 100644 --- a/plugins/catalog-react/src/hooks/useOwnUser.ts +++ b/plugins/catalog-react/src/hooks/useOwnUser.ts @@ -15,7 +15,7 @@ */ import { - ENTITY_DEFAULT_NAMESPACE, + DEFAULT_NAMESPACE, parseEntityRef, UserEntity, } from '@backstage/catalog-model'; @@ -35,7 +35,7 @@ export function useOwnUser(): AsyncState { return catalogApi.getEntityByName( parseEntityRef(identity.userEntityRef, { defaultKind: 'User', - defaultNamespace: ENTITY_DEFAULT_NAMESPACE, + defaultNamespace: DEFAULT_NAMESPACE, }), ) as Promise; }, [catalogApi, identityApi]); diff --git a/plugins/catalog-react/src/routes.ts b/plugins/catalog-react/src/routes.ts index 1fcbd14866..57801fab4a 100644 --- a/plugins/catalog-react/src/routes.ts +++ b/plugins/catalog-react/src/routes.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { Entity, ENTITY_DEFAULT_NAMESPACE } from '@backstage/catalog-model'; +import { Entity, DEFAULT_NAMESPACE } from '@backstage/catalog-model'; import { createRouteRef } from '@backstage/core-plugin-api'; import { getOrCreateGlobalSingleton } from '@backstage/version-bridge'; @@ -61,7 +61,7 @@ export function entityRouteParams(entity: Entity) { kind: entity.kind.toLocaleLowerCase('en-US'), namespace: entity.metadata.namespace?.toLocaleLowerCase('en-US') ?? - ENTITY_DEFAULT_NAMESPACE, + DEFAULT_NAMESPACE, name: entity.metadata.name, } as const; } diff --git a/plugins/catalog/src/components/AboutCard/AboutCard.tsx b/plugins/catalog/src/components/AboutCard/AboutCard.tsx index cb6e057e61..f552d50a68 100644 --- a/plugins/catalog/src/components/AboutCard/AboutCard.tsx +++ b/plugins/catalog/src/components/AboutCard/AboutCard.tsx @@ -16,8 +16,8 @@ import { Entity, - ENTITY_DEFAULT_NAMESPACE, ANNOTATION_LOCATION, + DEFAULT_NAMESPACE, stringifyEntityRef, } from '@backstage/catalog-model'; import { @@ -107,7 +107,7 @@ export function AboutCard({ variant }: AboutCardProps) { href: viewTechdocLink && viewTechdocLink({ - namespace: entity.metadata.namespace || ENTITY_DEFAULT_NAMESPACE, + namespace: entity.metadata.namespace || DEFAULT_NAMESPACE, kind: entity.kind, name: entity.metadata.name, }), diff --git a/plugins/catalog/src/components/EntityLayout/EntityLayout.tsx b/plugins/catalog/src/components/EntityLayout/EntityLayout.tsx index 144e5d01a8..0e93e74f2d 100644 --- a/plugins/catalog/src/components/EntityLayout/EntityLayout.tsx +++ b/plugins/catalog/src/components/EntityLayout/EntityLayout.tsx @@ -16,7 +16,7 @@ import { Entity, - ENTITY_DEFAULT_NAMESPACE, + DEFAULT_NAMESPACE, RELATION_OWNED_BY, } from '@backstage/catalog-model'; import { @@ -99,9 +99,7 @@ const headerProps = ( entity?.metadata.title ?? paramName ?? entity?.metadata.name ?? ''; return { headerTitle: `${name}${ - namespace && namespace !== ENTITY_DEFAULT_NAMESPACE - ? ` in ${namespace}` - : '' + namespace && namespace !== DEFAULT_NAMESPACE ? ` in ${namespace}` : '' }`, headerType: (() => { let t = kind.toLocaleLowerCase('en-US'); diff --git a/plugins/catalog/src/components/EntityPageLayout/EntityPageLayout.tsx b/plugins/catalog/src/components/EntityPageLayout/EntityPageLayout.tsx index 82a980afcb..52b05afa76 100644 --- a/plugins/catalog/src/components/EntityPageLayout/EntityPageLayout.tsx +++ b/plugins/catalog/src/components/EntityPageLayout/EntityPageLayout.tsx @@ -15,7 +15,7 @@ */ import { Entity, - ENTITY_DEFAULT_NAMESPACE, + DEFAULT_NAMESPACE, RELATION_OWNED_BY, } from '@backstage/catalog-model'; import { @@ -90,9 +90,7 @@ const headerProps = ( ): { headerTitle: string; headerType: string } => { return { headerTitle: `${name}${ - namespace && namespace !== ENTITY_DEFAULT_NAMESPACE - ? ` in ${namespace}` - : '' + namespace && namespace !== DEFAULT_NAMESPACE ? ` in ${namespace}` : '' }`, headerType: (() => { let t = kind.toLocaleLowerCase('en-US'); diff --git a/plugins/catalog/src/components/Router.tsx b/plugins/catalog/src/components/Router.tsx index e8b00d8513..8dd82c29e1 100644 --- a/plugins/catalog/src/components/Router.tsx +++ b/plugins/catalog/src/components/Router.tsx @@ -13,7 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -import { ENTITY_DEFAULT_NAMESPACE } from '@backstage/catalog-model'; +import { DEFAULT_NAMESPACE } from '@backstage/catalog-model'; import { AsyncEntityProvider, useEntity, @@ -61,7 +61,7 @@ const OldEntityRouteRedirect = () => { const { optionalNamespaceAndName, '*': rest } = useParams() as any; const [name, namespace] = optionalNamespaceAndName.split(':').reverse(); const namespaceLower = - namespace?.toLocaleLowerCase('en-US') ?? ENTITY_DEFAULT_NAMESPACE; + namespace?.toLocaleLowerCase('en-US') ?? DEFAULT_NAMESPACE; const restWithSlash = rest ? `/${rest}` : ''; return ( void; @@ -66,7 +63,7 @@ export const GroupsProvider = ({ children }: PropsWithChildren<{}>) => { const { userEntityRef } = await identityApi.getBackstageIdentity(); const { name: userId } = parseEntityRef(userEntityRef, { defaultKind: 'User', - defaultNamespace: ENTITY_DEFAULT_NAMESPACE, + defaultNamespace: DEFAULT_NAMESPACE, }); const g = await client.getUserGroups(userId); setGroups(g); diff --git a/plugins/ilert/src/components/Incident/IncidentActionsMenu.tsx b/plugins/ilert/src/components/Incident/IncidentActionsMenu.tsx index d58fa91108..909e4dc362 100644 --- a/plugins/ilert/src/components/Incident/IncidentActionsMenu.tsx +++ b/plugins/ilert/src/components/Incident/IncidentActionsMenu.tsx @@ -27,10 +27,7 @@ import { identityApiRef, } from '@backstage/core-plugin-api'; import { Progress, Link } from '@backstage/core-components'; -import { - ENTITY_DEFAULT_NAMESPACE, - parseEntityRef, -} from '@backstage/catalog-model'; +import { DEFAULT_NAMESPACE, parseEntityRef } from '@backstage/catalog-model'; export const IncidentActionsMenu = ({ incident, @@ -71,7 +68,7 @@ export const IncidentActionsMenu = ({ const { userEntityRef } = await identityApi.getBackstageIdentity(); const { name: userName } = parseEntityRef(userEntityRef, { defaultKind: 'User', - defaultNamespace: ENTITY_DEFAULT_NAMESPACE, + defaultNamespace: DEFAULT_NAMESPACE, }); const newIncident = await ilertApi.acceptIncident(incident, userName); alertApi.post({ message: 'Incident accepted.' }); @@ -91,7 +88,7 @@ export const IncidentActionsMenu = ({ const { userEntityRef } = await identityApi.getBackstageIdentity(); const { name: userName } = parseEntityRef(userEntityRef, { defaultKind: 'User', - defaultNamespace: ENTITY_DEFAULT_NAMESPACE, + defaultNamespace: DEFAULT_NAMESPACE, }); const newIncident = await ilertApi.resolveIncident(incident, userName); alertApi.post({ message: 'Incident resolved.' }); diff --git a/plugins/ilert/src/components/Incident/IncidentNewModal.tsx b/plugins/ilert/src/components/Incident/IncidentNewModal.tsx index c8f63c6073..561047d45e 100644 --- a/plugins/ilert/src/components/Incident/IncidentNewModal.tsx +++ b/plugins/ilert/src/components/Incident/IncidentNewModal.tsx @@ -14,10 +14,7 @@ * limitations under the License. */ import React from 'react'; -import { - ENTITY_DEFAULT_NAMESPACE, - parseEntityRef, -} from '@backstage/catalog-model'; +import { DEFAULT_NAMESPACE, parseEntityRef } from '@backstage/catalog-model'; import { makeStyles } from '@material-ui/core/styles'; import Alert from '@material-ui/lab/Alert'; import Button from '@material-ui/core/Button'; @@ -108,7 +105,7 @@ export const IncidentNewModal = ({ const { userEntityRef } = await identityApi.getBackstageIdentity(); const { name: userName } = parseEntityRef(userEntityRef, { defaultKind: 'User', - defaultNamespace: ENTITY_DEFAULT_NAMESPACE, + defaultNamespace: DEFAULT_NAMESPACE, }); await ilertApi.createIncident({ integrationKey, diff --git a/plugins/org/src/components/Cards/Group/MembersList/MembersListCard.tsx b/plugins/org/src/components/Cards/Group/MembersList/MembersListCard.tsx index 9a107f2d8f..74a4f6fc90 100644 --- a/plugins/org/src/components/Cards/Group/MembersList/MembersListCard.tsx +++ b/plugins/org/src/components/Cards/Group/MembersList/MembersListCard.tsx @@ -14,7 +14,7 @@ * limitations under the License. */ import { - ENTITY_DEFAULT_NAMESPACE, + DEFAULT_NAMESPACE, GroupEntity, UserEntity, stringifyEntityRef, @@ -124,7 +124,7 @@ export const MembersListCard = (_props: { const displayName = profile?.displayName ?? groupName; - const groupNamespace = grpNamespace || ENTITY_DEFAULT_NAMESPACE; + const groupNamespace = grpNamespace || DEFAULT_NAMESPACE; const [page, setPage] = React.useState(1); const pageChange = (_: React.ChangeEvent, pageIndex: number) => { diff --git a/plugins/pagerduty/src/components/TriggerDialog/TriggerDialog.tsx b/plugins/pagerduty/src/components/TriggerDialog/TriggerDialog.tsx index ef0659becb..171238cdd3 100644 --- a/plugins/pagerduty/src/components/TriggerDialog/TriggerDialog.tsx +++ b/plugins/pagerduty/src/components/TriggerDialog/TriggerDialog.tsx @@ -34,10 +34,7 @@ import { alertApiRef, identityApiRef, } from '@backstage/core-plugin-api'; -import { - ENTITY_DEFAULT_NAMESPACE, - parseEntityRef, -} from '@backstage/catalog-model'; +import { DEFAULT_NAMESPACE, parseEntityRef } from '@backstage/catalog-model'; type Props = { showDialog: boolean; @@ -61,7 +58,7 @@ export const TriggerDialog = ({ const { userEntityRef } = await identityApi.getBackstageIdentity(); const { name: userName } = parseEntityRef(userEntityRef, { defaultKind: 'User', - defaultNamespace: ENTITY_DEFAULT_NAMESPACE, + defaultNamespace: DEFAULT_NAMESPACE, }); await api.triggerAlarm({ integrationKey: integrationKey as string, diff --git a/plugins/search/src/components/LegacySearchPage/LegacySearchResult.tsx b/plugins/search/src/components/LegacySearchPage/LegacySearchResult.tsx index f48ffb61d7..ba92dba710 100644 --- a/plugins/search/src/components/LegacySearchPage/LegacySearchResult.tsx +++ b/plugins/search/src/components/LegacySearchPage/LegacySearchResult.tsx @@ -20,7 +20,7 @@ import useAsync from 'react-use/lib/useAsync'; import { catalogApiRef } from '@backstage/plugin-catalog-react'; import { Filters, FiltersButton, FiltersState } from './Filters'; -import { Entity, ENTITY_DEFAULT_NAMESPACE } from '@backstage/catalog-model'; +import { Entity, DEFAULT_NAMESPACE } from '@backstage/catalog-model'; import { EmptyState, @@ -156,7 +156,7 @@ export const SearchResult = ({ searchQuery }: SearchResultProps) => { : undefined, url: `/catalog/${ entity.metadata.namespace?.toLocaleLowerCase('en-US') || - ENTITY_DEFAULT_NAMESPACE + DEFAULT_NAMESPACE }/${entity.kind.toLocaleLowerCase('en-US')}/${entity.metadata.name}`, })); }, []); diff --git a/plugins/techdocs-backend/src/DocsBuilder/builder.ts b/plugins/techdocs-backend/src/DocsBuilder/builder.ts index 66eb52c1aa..05e9c0ce52 100644 --- a/plugins/techdocs-backend/src/DocsBuilder/builder.ts +++ b/plugins/techdocs-backend/src/DocsBuilder/builder.ts @@ -15,7 +15,7 @@ */ import { Entity, - ENTITY_DEFAULT_NAMESPACE, + DEFAULT_NAMESPACE, stringifyEntityRef, } from '@backstage/catalog-model'; import { Config } from '@backstage/config'; @@ -111,8 +111,7 @@ export class DocsBuilder { try { storedEtag = ( await this.publisher.fetchTechDocsMetadata({ - namespace: - this.entity.metadata.namespace ?? ENTITY_DEFAULT_NAMESPACE, + namespace: this.entity.metadata.namespace ?? DEFAULT_NAMESPACE, kind: this.entity.kind, name: this.entity.metadata.name, }) diff --git a/plugins/techdocs-backend/src/service/DocsSynchronizer.ts b/plugins/techdocs-backend/src/service/DocsSynchronizer.ts index 099eec152b..2979d2efe4 100644 --- a/plugins/techdocs-backend/src/service/DocsSynchronizer.ts +++ b/plugins/techdocs-backend/src/service/DocsSynchronizer.ts @@ -15,7 +15,7 @@ */ import { PluginEndpointDiscovery } from '@backstage/backend-common'; -import { Entity, ENTITY_DEFAULT_NAMESPACE } from '@backstage/catalog-model'; +import { Entity, DEFAULT_NAMESPACE } from '@backstage/catalog-model'; import { Config } from '@backstage/config'; import { assertError, NotFoundError } from '@backstage/errors'; import { ScmIntegrationRegistry } from '@backstage/integration'; @@ -177,7 +177,7 @@ export class DocsSynchronizer { // Fetch techdocs_metadata.json from the publisher and from cache. const baseUrl = await discovery.getBaseUrl('techdocs'); - const namespace = entity.metadata?.namespace || ENTITY_DEFAULT_NAMESPACE; + const namespace = entity.metadata?.namespace || DEFAULT_NAMESPACE; const kind = entity.kind; const name = entity.metadata.name; const legacyPathCasing =