Do not use deprecated LocationSpec

Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-11-18 17:06:18 +01:00
parent e42560af32
commit d8593ce0e6
16 changed files with 51 additions and 27 deletions
@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-catalog-backend': patch
+---
+
+Do not use deprecated `LocationSpec` from the `@backstage/plugin-catalog-node` package
@@ -37,7 +37,7 @@ import { EntityRelationSpec } from '@backstage/plugin-catalog-node';
 import { GetEntitiesRequest } from '@backstage/catalog-client';
 import { JsonValue } from '@backstage/types';
 import { LocationEntityV1alpha1 } from '@backstage/catalog-model';
-import { LocationSpec } from '@backstage/plugin-catalog-node';
+import { LocationSpec as LocationSpec_2 } from '@backstage/plugin-catalog-common';
 import { Logger } from 'winston';
 import { Permission } from '@backstage/plugin-permission-common';
 import { PermissionAuthorizer } from '@backstage/plugin-permission-common';
@@ -86,9 +86,9 @@ export class AnnotateLocationEntityProcessor implements CatalogProcessor {
  // (undocumented)
  preProcessEntity(
    entity: Entity,
-    location: LocationSpec,
+    location: LocationSpec_2,
    _: CatalogProcessorEmit,
-    originLocation: LocationSpec,
+    originLocation: LocationSpec_2,
  ): Promise<Entity>;
 }

@@ -100,7 +100,7 @@ export class AnnotateScmSlugEntityProcessor implements CatalogProcessor {
  // (undocumented)
  getProcessorName(): string;
  // (undocumented)
-  preProcessEntity(entity: Entity, location: LocationSpec): Promise<Entity>;
+  preProcessEntity(entity: Entity, location: LocationSpec_2): Promise<Entity>;
 }

 // @public (undocumented)
@@ -110,7 +110,7 @@ export class BuiltinKindsEntityProcessor implements CatalogProcessor {
  // (undocumented)
  postProcessEntity(
    entity: Entity,
-    _location: LocationSpec,
+    _location: LocationSpec_2,
    emit: CatalogProcessorEmit,
  ): Promise<Entity>;
  // (undocumented)
@@ -284,7 +284,7 @@ export class CodeOwnersProcessor implements CatalogProcessor {
  // (undocumented)
  getProcessorName(): string;
  // (undocumented)
-  preProcessEntity(entity: Entity, location: LocationSpec): Promise<Entity>;
+  preProcessEntity(entity: Entity, location: LocationSpec_2): Promise<Entity>;
 }

 // @alpha
@@ -409,7 +409,7 @@ export class FileReaderProcessor implements CatalogProcessor {
  getProcessorName(): string;
  // (undocumented)
  readLocation(
-    location: LocationSpec,
+    location: LocationSpec_2,
    optional: boolean,
    emit: CatalogProcessorEmit,
    parser: CatalogProcessorParser,
@@ -431,7 +431,7 @@ export class LocationEntityProcessor implements CatalogProcessor {
  // (undocumented)
  postProcessEntity(
    entity: Entity,
-    location: LocationSpec,
+    location: LocationSpec_2,
    emit: CatalogProcessorEmit,
  ): Promise<Entity>;
 }
@@ -441,18 +441,19 @@ export type LocationEntityProcessorOptions = {
  integrations: ScmIntegrationRegistry;
 };

-export { LocationSpec };
+// @public @deprecated
+export type LocationSpec = LocationSpec_2;

 // @public (undocumented)
 export function locationSpecToLocationEntity(opts: {
-  location: LocationSpec;
+  location: LocationSpec_2;
  parentEntity?: Entity;
 }): LocationEntityV1alpha1;

 // @public (undocumented)
 export function parseEntityYaml(
  data: Buffer,
-  location: LocationSpec,
+  location: LocationSpec_2,
 ): Iterable<CatalogProcessorResult>;

 // @alpha
@@ -518,7 +519,7 @@ export class PlaceholderProcessor implements CatalogProcessor {
  // (undocumented)
  preProcessEntity(
    entity: Entity,
-    location: LocationSpec,
+    location: LocationSpec_2,
    emit: CatalogProcessorEmit,
  ): Promise<Entity>;
 }
@@ -574,7 +575,7 @@ export class UrlReaderProcessor implements CatalogProcessor {
  getProcessorName(): string;
  // (undocumented)
  readLocation(
-    location: LocationSpec,
+    location: LocationSpec_2,
    optional: boolean,
    emit: CatalogProcessorEmit,
    parser: CatalogProcessorParser,
@@ -22,7 +22,6 @@

 export type {
  DeferredEntity,
-  LocationSpec,
  EntityRelationSpec,
  CatalogProcessor,
  CatalogProcessorParser,
@@ -48,3 +47,19 @@ export * from './processing';
 export * from './search';
 export * from './service';
 export * from './util';
+
+import { LocationSpec as NonDeprecatedLocationSpec } from '@backstage/plugin-catalog-common';
+
+/**
+ * Holds the entity location information.
+ *
+ * @remarks
+ *
+ *  `presence` flag: when using repo importer plugin, location is being created before the component yaml file is merged to the main branch.
+ *  This flag is then set to indicate that the file can be not present.
+ *  default value: 'required'.
+ *
+ * @public
+ * @deprecated use the same type from `@backstage/plugin-catalog-common` instead
+ */
+export type LocationSpec = NonDeprecatedLocationSpec;
@@ -17,7 +17,7 @@
 import { Config } from '@backstage/config';
 import { Entity } from '@backstage/catalog-model';
 import path from 'path';
-import { LocationSpec } from '@backstage/plugin-catalog-node';
+import { LocationSpec } from '@backstage/plugin-catalog-common';

 /**
 * Rules to apply to catalog entities.
@@ -22,7 +22,8 @@ import {
  ScmIntegrations,
 } from '@backstage/integration';
 import { Logger } from 'winston';
-import { CatalogProcessor, LocationSpec } from '@backstage/plugin-catalog-node';
+import { LocationSpec } from '@backstage/plugin-catalog-common';
+import { CatalogProcessor } from '@backstage/plugin-catalog-node';
 import { findCodeOwnerByTarget } from './lib';

 const ALLOWED_KINDS = ['API', 'Component', 'Domain', 'Resource', 'System'];
@@ -25,10 +25,10 @@ import {
 } from '@backstage/catalog-model';
 import { ScmIntegrationRegistry } from '@backstage/integration';
 import { identity, merge, pickBy } from 'lodash';
+import { LocationSpec } from '@backstage/plugin-catalog-common';
 import {
  CatalogProcessor,
  CatalogProcessorEmit,
-  LocationSpec,
 } from '@backstage/plugin-catalog-node';

 /** @public */
@@ -13,6 +13,7 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
+
 import { Entity } from '@backstage/catalog-model';
 import { Config } from '@backstage/config';
 import {
@@ -21,7 +22,8 @@ import {
 } from '@backstage/integration';
 import parseGitUrl from 'git-url-parse';
 import { identity, merge, pickBy } from 'lodash';
-import { CatalogProcessor, LocationSpec } from '@backstage/plugin-catalog-node';
+import { LocationSpec } from '@backstage/plugin-catalog-common';
+import { CatalogProcessor } from '@backstage/plugin-catalog-node';

 const GITHUB_ACTIONS_ANNOTATION = 'github.com/project-slug';
 const GITLAB_ACTIONS_ANNOTATION = 'gitlab.com/project-slug';
@@ -48,10 +48,10 @@ import {
  UserEntity,
  userEntityV1alpha1Validator,
 } from '@backstage/catalog-model';
+import { LocationSpec } from '@backstage/plugin-catalog-common';
 import {
  CatalogProcessor,
  CatalogProcessorEmit,
-  LocationSpec,
  processingResult,
 } from '@backstage/plugin-catalog-node';

@@ -18,11 +18,11 @@ import fs from 'fs-extra';
 import g from 'glob';
 import path from 'path';
 import { promisify } from 'util';
+import { LocationSpec } from '@backstage/plugin-catalog-common';
 import {
  CatalogProcessor,
  CatalogProcessorEmit,
  CatalogProcessorParser,
-  LocationSpec,
  processingResult,
 } from '@backstage/plugin-catalog-node';

@@ -17,11 +17,11 @@
 import { Entity, LocationEntity } from '@backstage/catalog-model';
 import { ScmIntegrationRegistry } from '@backstage/integration';
 import path from 'path';
+import { LocationSpec } from '@backstage/plugin-catalog-common';
 import {
  processingResult,
  CatalogProcessor,
  CatalogProcessorEmit,
-  LocationSpec,
 } from '@backstage/plugin-catalog-node';

 export function toAbsoluteUrl(
@@ -19,10 +19,10 @@ import { Entity } from '@backstage/catalog-model';
 import { JsonValue } from '@backstage/types';
 import { ScmIntegrationRegistry } from '@backstage/integration';
 import yaml from 'yaml';
+import { LocationSpec } from '@backstage/plugin-catalog-common';
 import {
  CatalogProcessor,
  CatalogProcessorEmit,
-  LocationSpec,
  processingResult,
 } from '@backstage/plugin-catalog-node';

@@ -20,6 +20,7 @@ import { assertError } from '@backstage/errors';
 import parseGitUrl from 'git-url-parse';
 import limiterFactory from 'p-limit';
 import { Logger } from 'winston';
+import { LocationSpec } from '@backstage/plugin-catalog-common';
 import {
  CatalogProcessor,
  CatalogProcessorCache,
@@ -27,7 +28,6 @@ import {
  CatalogProcessorEntityResult,
  CatalogProcessorParser,
  CatalogProcessorResult,
-  LocationSpec,
  processingResult,
 } from '@backstage/plugin-catalog-node';

@@ -17,10 +17,10 @@
 import { Entity, stringifyLocationRef } from '@backstage/catalog-model';
 import lodash from 'lodash';
 import yaml from 'yaml';
+import { LocationSpec } from '@backstage/plugin-catalog-common';
 import {
  CatalogProcessorParser,
  CatalogProcessorResult,
-  LocationSpec,
  processingResult,
 } from '@backstage/plugin-catalog-node';

@@ -32,10 +32,10 @@ import { JsonValue } from '@backstage/types';
 import { ScmIntegrationRegistry } from '@backstage/integration';
 import path from 'path';
 import { Logger } from 'winston';
+import { LocationSpec } from '@backstage/plugin-catalog-common';
 import {
  CatalogProcessor,
  CatalogProcessorParser,
-  LocationSpec,
  processingResult,
 } from '@backstage/plugin-catalog-node';
 import {
@@ -27,7 +27,7 @@ import { JsonObject, JsonValue } from '@backstage/types';
 import { InputError } from '@backstage/errors';
 import { ScmIntegrationRegistry } from '@backstage/integration';
 import path from 'path';
-import { LocationSpec } from '@backstage/plugin-catalog-node';
+import { LocationSpec } from '@backstage/plugin-catalog-common';

 export function isLocationEntity(entity: Entity): entity is LocationEntity {
  return entity.kind === 'Location';
@@ -23,7 +23,7 @@ import {
  stringifyLocationRef,
 } from '@backstage/catalog-model';
 import { createHash } from 'crypto';
-import { LocationSpec } from '@backstage/plugin-catalog-node';
+import { LocationSpec } from '@backstage/plugin-catalog-common';

 export function locationSpecToMetadataName(location: LocationSpec) {
  const hash = createHash('sha1')