microsoft / microsoft/TypeScript

enhance: Add tests for premature caching of contextual parameter types

Offen Anfängerfreundlich
#64,278 1 Kommentar 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Possible Improvement
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.3k
Ø Merge
2 T. 4 Std.
Gemergte PRs (30 T.)
132

Beschreibung

Acknowledgement
  • I acknowledge that issues using this template may be closed without further explanation at the maintainer's discretion.
Comment

Add tests for premature caching of contextual parameter types

The checker currently handles the following code correctly.

But the existing cases in contextuallyTypedParametersWithInitializers2.ts do not appear to cover the following case: the combination of premature type caching and parameter whose type is widened during contextual checking.

Example:

It is ok:

const fn: (reader: () => number, value: 1) => void =
  (get = () => x, x = 0) => {
    x.toFixed();
  };

Why this needs regression coverage:

when caching the symbol type, we need to check if it is context sensitive, as the author intentionly said:

func (c *Checker) getTypeOfVariableOrParameterOrProperty(symbol *ast.Symbol) *Type {
	links := c.valueSymbolLinks.Get(symbol)
	if links.resolvedType == nil {
		t := c.getTypeOfVariableOrParameterOrPropertyWorker(symbol)
		if t == nil {
			panic("Unexpected nil type")
		}
		// For a contextually typed parameter it is possible that a type has already
		// been assigned (in assignTypeToParameterAndFixTypeParameters), and we want
		// to preserve this type. In fact, we need to _prefer_ that type, but it won't
		// be assigned until contextual typing is complete, so we need to defer in
		// cases where contextual typing may take place.
		if links.resolvedType == nil && !c.isParameterOfContextSensitiveSignature(symbol) {
			links.resolvedType = t
		}
		return t
	}
	return links.resolvedType
}

Checking get = () => x queries x before its contextual parameter checking is complete:

  1. The initial query get the contextual type 1.
  2. Later, checking the default value 0 and widens the parameter's type to number.
  3. If the initial result 1 is cached, assignParameterType returns early and cannot assign the final type.

This would incorrectly produce the error:

Type '0' is not assignable to type '1'.

The existing guard in getTypeOfVariableOrParameterOrProperty prevents this premature caching:

!c.isParameterOfContextSensitiveSignature(symbol)

The example passes with the current implementation. Removing the guard will produce the incorrect TS2322 diagnostic.

Proposed change:

Just add this case to contextuallyTypedParametersWithInitializers2.ts

const test4: (reader: () => number, value: 1) => void =
  (get = () => x, x = 0) => {
    x.toFixed();
  };

Add this case to the contextual parameter initializer tests, together with type and symbol baselines, to protect the existing behavior against regressions.

Existing tests cover the caching guard’s effect on implicit any diagnostics. This test adds coverage of type widening for parameters with default initializers, ensuring that prematurely cached literal types do not cause spurious errors.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit contextuallyTypedParametersWithInitializers2.ts und den bestehenden Fällen für kontextbezogene Parameterinitialisierer und führe anschließend die zugehörigen Compiler-Tests aus. Füge den vorgeschlagenen Fall test4 hinzu und aktualisiere dessen Typ- und Symbol-Baselines. Als erledigt gilt die Aufgabe, wenn der Test mit dem aktuellen Caching-Guard besteht und nicht die überflüssige TS2322-Diagnose erzeugt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
go, typescript
Bereich
compilers, testing-qa
Issue-Typ
Bug
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Aktiv
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
78/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.