Elgato_dark/angular
1
0
Fork 0
mirror of https://github.com/angular/angular synced 2026-05-24 09:28:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

refactor(core): Log a warning when multiple pipes match a name (#50389)

Browse source 
Since this might be too breaking, let's log for now and wait for a major to throw an actual error.

Fixes #13569

PR Close #50389
This commit is contained in:
Matthieu Riegler 2023-05-20 22:09:21 +02:00 committed by Dylan Hunn
parent 1ec2aa902d
commit 3dafc14e84
3 changed files with 32 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
goldens/public-api/core/errors.md
View file

@ -89,6 +89,8 @@ export const enum RuntimeErrorCode {
// (undocumented)
MULTIPLE_COMPONENTS_MATCH = -300,
// (undocumented)
MULTIPLE_MATCHING_PIPES = 313,
// (undocumented)
MULTIPLE_PLATFORMS = 400,
// (undocumented)
NO_SUPPORTING_DIFFER_FACTORY = 901,

1
packages/core/src/errors.ts
View file

@ -57,6 +57,7 @@ export const enum RuntimeErrorCode {
HOST_DIRECTIVE_COMPONENT = 310,
HOST_DIRECTIVE_UNDEFINED_BINDING = 311,
HOST_DIRECTIVE_CONFLICTING_ALIAS = 312,
MULTIPLE_MATCHING_PIPES = 313,
// Bootstrap Errors
MULTIPLE_PLATFORMS = 400,

30
packages/core/src/render3/pipe.ts
View file

@ -8,7 +8,7 @@
import {PipeTransform} from '../change_detection/pipe_transform';
import {setInjectImplementation} from '../di/inject_switch';
import {RuntimeError, RuntimeErrorCode} from '../errors';
import {formatRuntimeError, RuntimeError, RuntimeErrorCode} from '../errors';
import {Type} from '../interface/type';
import {getFactoryDef} from './definition_factory';
@ -76,6 +76,14 @@ export function ɵɵpipe(index: number, pipeName: string): any {
*/
function getPipeDef(name: string, registry: PipeDefList|null): PipeDef<any>|undefined {
if (registry) {
if (ngDevMode) {
const pipes = registry.filter(pipe => pipe.name === name);
// TODO: Throw an error in the next major
if (pipes.length > 1) {
console.warn(formatRuntimeError(
RuntimeErrorCode.MULTIPLE_MATCHING_PIPES, getMultipleMatchingPipesMessage(name)));
}
}
for (let i = registry.length - 1; i >= 0; i--) {
const pipeDef = registry[i];
if (name === pipeDef.name) {
@ -88,6 +96,26 @@ function getPipeDef(name: string, registry: PipeDefList|null): PipeDef<any>|unde
}
}
/**
* Generates a helpful error message for the user when multiple pipes match the name.
*
* @param name Name of the pipe
* @returns The error message
*/
function getMultipleMatchingPipesMessage(name: string) {
const lView = getLView();
const declarationLView = lView[DECLARATION_COMPONENT_VIEW] as LView<Type<unknown>>;
const context = declarationLView[CONTEXT];
const hostIsStandalone = isHostComponentStandalone(lView);
const componentInfoMessage = context ? ` in the '${context.constructor.name}' component` : '';
const verifyMessage = `check ${
hostIsStandalone ? '\'@Component.imports\' of this component' :
'the imports of this module'}`;
const errorMessage =
`Multiple pipes match the name \`${name}\`${componentInfoMessage}. ${verifyMessage}`;
return errorMessage;
}
/**
* Generates a helpful error message for the user when a pipe is not found.
*