microsoft / microsoft/TypeScript
Don't allow falsely discarded parameters when determining overloaded signature compatibility
Personne n'a encore pris cette issue.
- Langage dominant
- Go
- Étoiles
- 111k
- Forks
- 14.3k
- Merge moyen
- 2 j 4 h
- PR mergées (30 j)
- 132
Description
Motivation
Libraries such as Knockout use overloaded functions, for example:
var x = new MyKnockoutModel();
console.log(x.customerName()); // string
x.customerName('bob'); // OK
x.customerName(42); // Error, 42 is not a string
We can model these in TypeScript:
interface KnockoutElement<T> {
// Getter
(): T;
// Setter
(value: T): void;
}
However, these overloads turn out to not be safe when used in callbacks. For example:
function readFile(finished: (contents: string) => void) { /*... */ }
var ko: KnockoutElement<number>;
readFile(ko); // No error, but passes a string to a number-expecting setter!
This is because we look at all the candidate source signatures, reject the (x :number) => void signature for having an incompatible type, and accept the () => T signature because it has fewer parameters (an acceptable variance).
This behavior does not map to any actual runtime behavior. The invoker's side might check the .length property of the function to determine what kind of arguments to pass, and the invokee's side might check arguments.length to determine which overload was intended, but the invoker cannot tell what the expected parameter type of the function is, and the invokee reasonably expects to be called with the correct type given a certain arity.
Proposal
As an example, if a callback declaration says it’s going to invoke f with two parameters, we should not consider overloads of f which take zero arguments if an overload with one or two arguments exists.
In 3.8.3 / 3.8.4:
M is a non-specialized call or construct signature and S’ contains a call or construct signature N where […]
Change to
M is a non-specialized call or construct signature and S’ contains a call or construct signature N where no other call or construct signature in S’ has more parameters than N but not more than M, and […]
Analysis
A sample implementation of this rule breaks no existing tests. Check stopParameterNeglect branch for code/tests.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par la proposition et examinez la branche stopParameterNeglect, y compris son code et ses tests. Exécutez d’abord les tests existants, puis comparez le comportement de compatibilité des signatures avec la règle proposée concernant le nombre de paramètres. Le travail est terminé lorsque les overloads qui acceptent moins de paramètres ne sont pas sélectionnés lorsqu’un overload compatible accepte davantage de paramètres dans la limite de l’arité du callback, sans casser les tests existants.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- compilers
- Type d'issue
- Bug
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 48/100