Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Explicitly Omit unspreadable properties from rest type in the generic case #47078

Merged
merged 9 commits into from
Dec 9, 2021
Merged

Explicitly Omit unspreadable properties from rest type in the generic case #47078

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
f532408
Add test case
jakebailey Dec 7, 2021
d213a4d
Do not use Omit on this when getting rest type
jakebailey Dec 9, 2021
57a6ef7
Add failing test case for regular type param
jakebailey Dec 9, 2021
db5e9fa
Explicitly omit keys unspreadable in rest
jakebailey Dec 9, 2021
7d0aa5c
Add tests for method
jakebailey Dec 9, 2021
5eb70f8
Rename test to better reflect result
jakebailey Dec 9, 2021
d45768e
Test a setter
jakebailey Dec 9, 2021
f2bb9b7
Test all different possibilities
jakebailey Dec 9, 2021
c6f0f2f
Also test protected, given omitting private/protected is correct
jakebailey Dec 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 27 additions & 7 deletions src/compiler/checker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8464,8 +8464,32 @@ namespace ts {
if (source.flags & TypeFlags.Union) {
return mapType(source, t => getRestType(t, properties, symbol));
}
const omitKeyType = getUnionType(map(properties, getLiteralTypeFromPropertyName));

let omitKeyType = getUnionType(map(properties, getLiteralTypeFromPropertyName));

const spreadableProperties: Symbol[] = [];
const unspreadableToRestKeys: Type[] = [];

for (const prop of getPropertiesOfType(source)) {
const literalTypeFromProperty = getLiteralTypeFromProperty(prop, TypeFlags.StringOrNumberLiteralOrUnique);
if (!isTypeAssignableTo(literalTypeFromProperty, omitKeyType)
&& !(getDeclarationModifierFlagsFromSymbol(prop) & (ModifierFlags.Private | ModifierFlags.Protected))
&& isSpreadableProperty(prop)) {
spreadableProperties.push(prop);
}
else {
unspreadableToRestKeys.push(literalTypeFromProperty);
}
}

if (isGenericObjectType(source) || isGenericIndexType(omitKeyType)) {
if (unspreadableToRestKeys.length) {
// If the type we're spreading from has properties that cannot
// be spread into the rest type (e.g. getters, methods), ensure
// they are explicitly omitted, as they would in the non-generic case.
omitKeyType = getUnionType([omitKeyType, ...unspreadableToRestKeys]);
}

if (omitKeyType.flags & TypeFlags.Never) {
return source;
}
Expand All @@ -8477,12 +8501,8 @@ namespace ts {
return getTypeAliasInstantiation(omitTypeAlias, [source, omitKeyType]);
}
const members = createSymbolTable();
for (const prop of getPropertiesOfType(source)) {
if (!isTypeAssignableTo(getLiteralTypeFromProperty(prop, TypeFlags.StringOrNumberLiteralOrUnique), omitKeyType)
&& !(getDeclarationModifierFlagsFromSymbol(prop) & (ModifierFlags.Private | ModifierFlags.Protected))
&& isSpreadableProperty(prop)) {
members.set(prop.escapedName, getSpreadSymbol(prop, /*readonly*/ false));
}
for (const prop of spreadableProperties) {
members.set(prop.escapedName, getSpreadSymbol(prop, /*readonly*/ false));
}
const result = createAnonymousType(symbol, members, emptyArray, emptyArray, getIndexInfosOfType(source));
result.objectFlags |= ObjectFlags.ObjectRestType;
Expand Down
188 changes: 188 additions & 0 deletions tests/baselines/reference/destructuringUnspreadableIntoRest.errors.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,188 @@
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(21,15): error TS2339: Property 'publicProp' does not exist on type 'Omit<this, "publicProp" | "getter" | "setter" | "method">'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(22,15): error TS2339: Property 'publicProp' does not exist on type '{}'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(24,15): error TS2339: Property 'privateProp' does not exist on type 'Omit<this, "getter" | "setter" | "method">'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(25,15): error TS2339: Property 'privateProp' does not exist on type '{ publicProp: string; }'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(26,15): error TS2339: Property 'privateProp' does not exist on type 'Omit<this, "publicProp" | "getter" | "setter" | "method">'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(27,15): error TS2339: Property 'privateProp' does not exist on type '{}'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(29,15): error TS2339: Property 'getter' does not exist on type 'Omit<this, "getter" | "setter" | "method">'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(30,15): error TS2339: Property 'getter' does not exist on type '{ publicProp: string; }'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(31,15): error TS2339: Property 'getter' does not exist on type 'Omit<this, "publicProp" | "getter" | "setter" | "method">'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(32,15): error TS2339: Property 'getter' does not exist on type '{}'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(34,15): error TS2339: Property 'setter' does not exist on type 'Omit<this, "getter" | "setter" | "method">'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(35,15): error TS2339: Property 'setter' does not exist on type '{ publicProp: string; }'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(36,15): error TS2339: Property 'setter' does not exist on type 'Omit<this, "publicProp" | "getter" | "setter" | "method">'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(37,15): error TS2339: Property 'setter' does not exist on type '{}'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(39,15): error TS2339: Property 'method' does not exist on type 'Omit<this, "getter" | "setter" | "method">'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(40,15): error TS2339: Property 'method' does not exist on type '{ publicProp: string; }'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(41,15): error TS2339: Property 'method' does not exist on type 'Omit<this, "publicProp" | "getter" | "setter" | "method">'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(42,15): error TS2339: Property 'method' does not exist on type '{}'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(54,11): error TS2339: Property 'publicProp' does not exist on type 'Omit<T, "publicProp" | "getter" | "setter" | "method">'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(55,11): error TS2339: Property 'publicProp' does not exist on type '{}'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(57,11): error TS2339: Property 'privateProp' does not exist on type 'Omit<T, "getter" | "setter" | "method">'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(58,11): error TS2339: Property 'privateProp' does not exist on type '{ publicProp: string; }'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(59,11): error TS2339: Property 'privateProp' does not exist on type 'Omit<T, "publicProp" | "getter" | "setter" | "method">'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(60,11): error TS2339: Property 'privateProp' does not exist on type '{}'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(62,11): error TS2339: Property 'getter' does not exist on type 'Omit<T, "getter" | "setter" | "method">'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(63,11): error TS2339: Property 'getter' does not exist on type '{ publicProp: string; }'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(64,11): error TS2339: Property 'getter' does not exist on type 'Omit<T, "publicProp" | "getter" | "setter" | "method">'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(65,11): error TS2339: Property 'getter' does not exist on type '{}'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(67,11): error TS2339: Property 'setter' does not exist on type 'Omit<T, "getter" | "setter" | "method">'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(68,11): error TS2339: Property 'setter' does not exist on type '{ publicProp: string; }'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(69,11): error TS2339: Property 'setter' does not exist on type 'Omit<T, "publicProp" | "getter" | "setter" | "method">'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(70,11): error TS2339: Property 'setter' does not exist on type '{}'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(72,11): error TS2339: Property 'method' does not exist on type 'Omit<T, "getter" | "setter" | "method">'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(73,11): error TS2339: Property 'method' does not exist on type '{ publicProp: string; }'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(74,11): error TS2339: Property 'method' does not exist on type 'Omit<T, "publicProp" | "getter" | "setter" | "method">'.
tests/cases/compiler/destructuringUnspreadableIntoRest.ts(75,11): error TS2339: Property 'method' does not exist on type '{}'.


==== tests/cases/compiler/destructuringUnspreadableIntoRest.ts (36 errors) ====
class A {
constructor(
public publicProp: string,
private privateProp: string,
) {}

get getter(): number {
return 1;
}

set setter(_v: number) {}

method() {
const { ...rest1 } = this;
const { ...rest2 } = this as A;
const { publicProp: _1, ...rest3 } = this;
const { publicProp: _2, ...rest4 } = this as A;

rest1.publicProp;
rest2.publicProp;
rest3.publicProp;
~~~~~~~~~~
!!! error TS2339: Property 'publicProp' does not exist on type 'Omit<this, "publicProp" | "getter" | "setter" | "method">'.
rest4.publicProp;
~~~~~~~~~~
!!! error TS2339: Property 'publicProp' does not exist on type '{}'.

rest1.privateProp;
~~~~~~~~~~~
!!! error TS2339: Property 'privateProp' does not exist on type 'Omit<this, "getter" | "setter" | "method">'.
rest2.privateProp;
~~~~~~~~~~~
!!! error TS2339: Property 'privateProp' does not exist on type '{ publicProp: string; }'.
rest3.privateProp;
~~~~~~~~~~~
!!! error TS2339: Property 'privateProp' does not exist on type 'Omit<this, "publicProp" | "getter" | "setter" | "method">'.
rest4.privateProp;
~~~~~~~~~~~
!!! error TS2339: Property 'privateProp' does not exist on type '{}'.

rest1.getter;
~~~~~~
!!! error TS2339: Property 'getter' does not exist on type 'Omit<this, "getter" | "setter" | "method">'.
rest2.getter;
~~~~~~
!!! error TS2339: Property 'getter' does not exist on type '{ publicProp: string; }'.
rest3.getter;
~~~~~~
!!! error TS2339: Property 'getter' does not exist on type 'Omit<this, "publicProp" | "getter" | "setter" | "method">'.
rest4.getter;
~~~~~~
!!! error TS2339: Property 'getter' does not exist on type '{}'.

rest1.setter;
~~~~~~
!!! error TS2339: Property 'setter' does not exist on type 'Omit<this, "getter" | "setter" | "method">'.
rest2.setter;
~~~~~~
!!! error TS2339: Property 'setter' does not exist on type '{ publicProp: string; }'.
rest3.setter;
~~~~~~
!!! error TS2339: Property 'setter' does not exist on type 'Omit<this, "publicProp" | "getter" | "setter" | "method">'.
rest4.setter;
~~~~~~
!!! error TS2339: Property 'setter' does not exist on type '{}'.

rest1.method;
~~~~~~
!!! error TS2339: Property 'method' does not exist on type 'Omit<this, "getter" | "setter" | "method">'.
rest2.method;
~~~~~~
!!! error TS2339: Property 'method' does not exist on type '{ publicProp: string; }'.
rest3.method;
~~~~~~
!!! error TS2339: Property 'method' does not exist on type 'Omit<this, "publicProp" | "getter" | "setter" | "method">'.
rest4.method;
~~~~~~
!!! error TS2339: Property 'method' does not exist on type '{}'.
}
}

function destructure<T extends A>(x: T) {
const { ...rest1 } = x;
const { ...rest2 } = x as A;
const { publicProp: _1, ...rest3 } = x;
const { publicProp: _2, ...rest4 } = x as A;

rest1.publicProp;
rest2.publicProp;
rest3.publicProp;
~~~~~~~~~~
!!! error TS2339: Property 'publicProp' does not exist on type 'Omit<T, "publicProp" | "getter" | "setter" | "method">'.
rest4.publicProp;
~~~~~~~~~~
!!! error TS2339: Property 'publicProp' does not exist on type '{}'.

rest1.privateProp;
~~~~~~~~~~~
!!! error TS2339: Property 'privateProp' does not exist on type 'Omit<T, "getter" | "setter" | "method">'.
rest2.privateProp;
~~~~~~~~~~~
!!! error TS2339: Property 'privateProp' does not exist on type '{ publicProp: string; }'.
rest3.privateProp;
~~~~~~~~~~~
!!! error TS2339: Property 'privateProp' does not exist on type 'Omit<T, "publicProp" | "getter" | "setter" | "method">'.
rest4.privateProp;
~~~~~~~~~~~
!!! error TS2339: Property 'privateProp' does not exist on type '{}'.

rest1.getter;
~~~~~~
!!! error TS2339: Property 'getter' does not exist on type 'Omit<T, "getter" | "setter" | "method">'.
rest2.getter;
~~~~~~
!!! error TS2339: Property 'getter' does not exist on type '{ publicProp: string; }'.
rest3.getter;
~~~~~~
!!! error TS2339: Property 'getter' does not exist on type 'Omit<T, "publicProp" | "getter" | "setter" | "method">'.
rest4.getter;
~~~~~~
!!! error TS2339: Property 'getter' does not exist on type '{}'.

rest1.setter;
~~~~~~
!!! error TS2339: Property 'setter' does not exist on type 'Omit<T, "getter" | "setter" | "method">'.
rest2.setter;
~~~~~~
!!! error TS2339: Property 'setter' does not exist on type '{ publicProp: string; }'.
rest3.setter;
~~~~~~
!!! error TS2339: Property 'setter' does not exist on type 'Omit<T, "publicProp" | "getter" | "setter" | "method">'.
rest4.setter;
~~~~~~
!!! error TS2339: Property 'setter' does not exist on type '{}'.

rest1.method;
~~~~~~
!!! error TS2339: Property 'method' does not exist on type 'Omit<T, "getter" | "setter" | "method">'.
rest2.method;
~~~~~~
!!! error TS2339: Property 'method' does not exist on type '{ publicProp: string; }'.
rest3.method;
~~~~~~
!!! error TS2339: Property 'method' does not exist on type 'Omit<T, "publicProp" | "getter" | "setter" | "method">'.
rest4.method;
~~~~~~
!!! error TS2339: Property 'method' does not exist on type '{}'.
}

153 changes: 153 additions & 0 deletions tests/baselines/reference/destructuringUnspreadableIntoRest.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
//// [destructuringUnspreadableIntoRest.ts]
class A {
constructor(
public publicProp: string,
private privateProp: string,
) {}

get getter(): number {
return 1;
}

set setter(_v: number) {}

method() {
const { ...rest1 } = this;
const { ...rest2 } = this as A;
const { publicProp: _1, ...rest3 } = this;
const { publicProp: _2, ...rest4 } = this as A;

rest1.publicProp;
rest2.publicProp;
rest3.publicProp;
rest4.publicProp;

rest1.privateProp;
rest2.privateProp;
rest3.privateProp;
rest4.privateProp;

rest1.getter;
rest2.getter;
rest3.getter;
rest4.getter;

rest1.setter;
rest2.setter;
rest3.setter;
rest4.setter;

rest1.method;
rest2.method;
rest3.method;
rest4.method;
}
}

function destructure<T extends A>(x: T) {
const { ...rest1 } = x;
const { ...rest2 } = x as A;
const { publicProp: _1, ...rest3 } = x;
const { publicProp: _2, ...rest4 } = x as A;

rest1.publicProp;
rest2.publicProp;
rest3.publicProp;
rest4.publicProp;

rest1.privateProp;
rest2.privateProp;
rest3.privateProp;
rest4.privateProp;

rest1.getter;
rest2.getter;
rest3.getter;
rest4.getter;

rest1.setter;
rest2.setter;
rest3.setter;
rest4.setter;

rest1.method;
rest2.method;
rest3.method;
rest4.method;
}


//// [destructuringUnspreadableIntoRest.js]
var __rest = (this && this.__rest) || function (s, e) {
var t = {};
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
t[p] = s[p];
if (s != null && typeof Object.getOwnPropertySymbols === "function")
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
t[p[i]] = s[p[i]];
}
return t;
};
class A {
constructor(publicProp, privateProp) {
this.publicProp = publicProp;
this.privateProp = privateProp;
}
get getter() {
return 1;
}
set setter(_v) { }
method() {
const rest1 = __rest(this, []);
const rest2 = __rest(this, []);
const _a = this, { publicProp: _1 } = _a, rest3 = __rest(_a, ["publicProp"]);
const _b = this, { publicProp: _2 } = _b, rest4 = __rest(_b, ["publicProp"]);
rest1.publicProp;
rest2.publicProp;
rest3.publicProp;
rest4.publicProp;
rest1.privateProp;
rest2.privateProp;
rest3.privateProp;
rest4.privateProp;
rest1.getter;
rest2.getter;
rest3.getter;
rest4.getter;
rest1.setter;
rest2.setter;
rest3.setter;
rest4.setter;
rest1.method;
rest2.method;
rest3.method;
rest4.method;
}
}
function destructure(x) {
const rest1 = __rest(x, []);
const rest2 = __rest(x, []);
const { publicProp: _1 } = x, rest3 = __rest(x, ["publicProp"]);
const _a = x, { publicProp: _2 } = _a, rest4 = __rest(_a, ["publicProp"]);
rest1.publicProp;
rest2.publicProp;
rest3.publicProp;
rest4.publicProp;
rest1.privateProp;
rest2.privateProp;
rest3.privateProp;
rest4.privateProp;
rest1.getter;
rest2.getter;
rest3.getter;
rest4.getter;
rest1.setter;
rest2.setter;
rest3.setter;
rest4.setter;
rest1.method;
rest2.method;
rest3.method;
rest4.method;
}
Loading