diff --git a/plugins/catalog-backend/src/processing/DefaultCatalogProcessingOrchestrator.ts b/plugins/catalog-backend/src/processing/DefaultCatalogProcessingOrchestrator.ts index 339469ff1d..d177a7d4a8 100644 --- a/plugins/catalog-backend/src/processing/DefaultCatalogProcessingOrchestrator.ts +++ b/plugins/catalog-backend/src/processing/DefaultCatalogProcessingOrchestrator.ts @@ -187,7 +187,7 @@ export class DefaultCatalogProcessingOrchestrator res = await processor.preProcessEntity( res, context.location, - context.collector.onEmit, + context.collector.forProcessor(processor), context.originLocation, context.cache.forProcessor(processor), ); @@ -300,7 +300,7 @@ export class DefaultCatalogProcessingOrchestrator for (const maybeRelativeTarget of targets) { if (type === 'file' && maybeRelativeTarget.endsWith(path.sep)) { - context.collector.onEmit( + context.collector.generic()( processingResult.inputError( context.location, `LocationEntityProcessor cannot handle ${type} type location with target ${context.location.target} that ends with a path separator`, @@ -326,7 +326,7 @@ export class DefaultCatalogProcessingOrchestrator presence, }, presence === 'optional', - context.collector.onEmit, + context.collector.forProcessor(processor), this.options.parser, context.cache.forProcessor(processor, target), ); @@ -365,7 +365,7 @@ export class DefaultCatalogProcessingOrchestrator res = await processor.postProcessEntity( res, context.location, - context.collector.onEmit, + context.collector.forProcessor(processor), context.cache.forProcessor(processor), ); } catch (e) { diff --git a/plugins/catalog-backend/src/processing/ProcessorOutputCollector.ts b/plugins/catalog-backend/src/processing/ProcessorOutputCollector.ts index 55282baa38..0ee6191284 100644 --- a/plugins/catalog-backend/src/processing/ProcessorOutputCollector.ts +++ b/plugins/catalog-backend/src/processing/ProcessorOutputCollector.ts @@ -24,6 +24,7 @@ import { import { assertError } from '@backstage/errors'; import { Logger } from 'winston'; import { + CatalogProcessor, CatalogProcessorResult, DeferredEntity, EntityRelationSpec, @@ -51,8 +52,17 @@ export class ProcessorOutputCollector { private readonly parentEntity: Entity, ) {} - get onEmit(): (i: CatalogProcessorResult) => void { - return i => this.receive(i); + generic(): (i: CatalogProcessorResult) => void { + return i => this.receive(this.logger, i); + } + + forProcessor( + processor: CatalogProcessor, + ): (i: CatalogProcessorResult) => void { + const logger = this.logger.child({ + processor: processor.getProcessorName(), + }); + return i => this.receive(logger, i); } results() { @@ -65,9 +75,9 @@ export class ProcessorOutputCollector { }; } - private receive(i: CatalogProcessorResult) { + private receive(logger: Logger, i: CatalogProcessorResult) { if (this.done) { - this.logger.warn( + logger.warn( `Item of type "${ i.type }" was emitted after processing had completed. Stack trace: ${ @@ -85,7 +95,7 @@ export class ProcessorOutputCollector { entity = validateEntityEnvelope(i.entity); } catch (e) { assertError(e); - this.logger.debug(`Envelope validation failed at ${location}, ${e}`); + logger.debug(`Envelope validation failed at ${location}, ${e}`); this.errors.push(e); return; } @@ -95,9 +105,11 @@ export class ProcessorOutputCollector { // accidentally forgotten. This can lead to circular references which at // best is wasteful, so we try to be helpful by ignoring such emitted // entities. - if ( - stringifyEntityRef(entity) === stringifyEntityRef(this.parentEntity) - ) { + const entityRef = stringifyEntityRef(entity); + if (entityRef === stringifyEntityRef(this.parentEntity)) { + logger.warn( + `Ignored emitted entity ${entityRef} whose ref was identical to the one being processed. This commonly indicates mistakenly emitting the input entity instead of returning it.`, + ); return; }