Skip to content

Make Number and String literal types immutable. #28344

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

Closed
wants to merge 5 commits into from
Closed

Make Number and String literal types immutable. #28344

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c7ef14c
prohibit mutation for Number + String literal types
collin5 Nov 5, 2018
00844bb
refactor + add new baseline tests
collin5 Nov 5, 2018
f235b37
check mutation for object properties
collin5 Nov 6, 2018
1512028
check both prefix + postfix unary expressions
collin5 Nov 6, 2018
ddc9c16
add more baseline tests + refactor
collin5 Nov 6, 2018
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: 31 additions & 3 deletions src/compiler/checker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13268,6 +13268,11 @@ namespace ts {
isUnitType(type);
}

function isStringOrNumericLiteralType(type: Type): boolean {
return type.flags & TypeFlags.Union ? every((<UnionType>type).types, t => !!(t.flags & TypeFlags.StringOrNumberLiteral && !(t.flags & (TypeFlags.EnumLike | TypeFlags.Intrinsic)))) :
!!(type.flags & TypeFlags.StringOrNumberLiteral) && !(type.flags & (TypeFlags.EnumLike | TypeFlags.Intrinsic));
}

function getBaseTypeOfLiteralType(type: Type): Type {
return type.flags & TypeFlags.EnumLiteral ? getBaseTypeOfEnumLiteralType(<LiteralType>type) :
type.flags & TypeFlags.StringLiteral ? stringType :
Expand Down Expand Up @@ -21828,6 +21833,21 @@ namespace ts {
return numberType;
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use isEntityNameExpression and not left.escapedText (since checking a.b += 1 is also desireable. Also, a test for a.b += 1 would be good.


function checkUnaryExpression(node: PrefixUnaryExpression | PostfixUnaryExpression): Type {
const symbol = isEntityNameExpression(node.operand) ? isPropertyAccessEntityNameExpression(node.operand) ?
getSymbolAtLocation((<PropertyAccessExpression>node.operand).name) : getResolvedSymbol(node.operand) : undefined;
if (symbol && isUnaryAssignmentOperator(node.operator) && !(getDeclarationNodeFlagsFromSymbol(symbol) & NodeFlags.Const)) {
const operandType = getTypeOfSymbol(symbol);
if (isStringOrNumericLiteralType(operandType)) {
error(node.operand, Diagnostics.The_literal_type_0_cannot_be_modified, typeToString(operandType));
}
}
if (node.kind === SyntaxKind.PrefixUnaryExpression) {
return checkPrefixUnaryExpression(node);
}
return checkPostfixUnaryExpression(node);
}

// Return true if type might be of the given kind. A union or intersection type might be of a given
// kind if at least one constituent type is of the given kind.
function maybeTypeOfKind(type: Type, kind: TypeFlags): boolean {
Expand Down Expand Up @@ -22170,10 +22190,19 @@ namespace ts {

function checkBinaryLikeExpression(left: Expression, operatorToken: Node, right: Expression, checkMode?: CheckMode, errorNode?: Node): Type {
const operator = operatorToken.kind;
let leftType: Type;

const symbol = isEntityNameExpression(left) ? isPropertyAccessEntityNameExpression(left) ?
getSymbolAtLocation((<PropertyAccessExpression>left).name) : getResolvedSymbol(left) : undefined;
if (symbol && isCompoundAssignmentOperator(operator) && !(getDeclarationNodeFlagsFromSymbol(symbol) & NodeFlags.Const)) {
leftType = getTypeOfSymbol(getResolvedSymbol(left as Identifier));
if (isStringOrNumericLiteralType(leftType)) {
error(left, Diagnostics.The_literal_type_0_cannot_be_modified, typeToString(leftType));
}
}
if (operator === SyntaxKind.EqualsToken && (left.kind === SyntaxKind.ObjectLiteralExpression || left.kind === SyntaxKind.ArrayLiteralExpression)) {
return checkDestructuringAssignment(left, checkExpression(right, checkMode), checkMode, right.kind === SyntaxKind.ThisKeyword);
}
let leftType: Type;
if (operator === SyntaxKind.AmpersandAmpersandToken || operator === SyntaxKind.BarBarToken) {
leftType = checkTruthinessExpression(left, checkMode);
}
Expand Down Expand Up @@ -22866,9 +22895,8 @@ namespace ts {
case SyntaxKind.AwaitExpression:
return checkAwaitExpression(<AwaitExpression>node);
case SyntaxKind.PrefixUnaryExpression:
return checkPrefixUnaryExpression(<PrefixUnaryExpression>node);
case SyntaxKind.PostfixUnaryExpression:
return checkPostfixUnaryExpression(<PostfixUnaryExpression>node);
return checkUnaryExpression(<PrefixUnaryExpression | PostfixUnaryExpression>node);
case SyntaxKind.BinaryExpression:
return checkBinaryExpression(<BinaryExpression>node, checkMode);
case SyntaxKind.ConditionalExpression:
Expand Down
4 changes: 4 additions & 0 deletions src/compiler/diagnosticMessages.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2529,6 +2529,10 @@
"category": "Error",
"code": 2742
},
"The literal type '{0}' cannot be modified.": {
"category": "Error",
"code": 2743
},

"Import declaration '{0}' is using private name '{1}'.": {
"category": "Error",
Expand Down
21 changes: 21 additions & 0 deletions src/compiler/utilities.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3839,6 +3839,27 @@ namespace ts {
|| token === SyntaxKind.ExclamationToken;
}

export function isCompoundAssignmentOperator(token: SyntaxKind): boolean {
return token === SyntaxKind.PlusEqualsToken
|| token === SyntaxKind.MinusEqualsToken
|| token === SyntaxKind.AsteriskAsteriskEqualsToken
|| token === SyntaxKind.AsteriskEqualsToken
|| token === SyntaxKind.SlashEqualsToken
|| token === SyntaxKind.PercentEqualsToken
|| token === SyntaxKind.AmpersandEqualsToken
|| token === SyntaxKind.BarEqualsToken
|| token === SyntaxKind.CaretEqualsToken
|| token === SyntaxKind.LessThanLessThanEqualsToken
|| token === SyntaxKind.GreaterThanGreaterThanGreaterThanEqualsToken
|| token === SyntaxKind.GreaterThanGreaterThanEqualsToken;
}

export function isUnaryAssignmentOperator(token: SyntaxKind): boolean {
return token === SyntaxKind.PlusPlusToken
|| token === SyntaxKind.MinusMinusToken;

}

export function isAssignmentOperator(token: SyntaxKind): boolean {
return token >= SyntaxKind.FirstAssignment && token <= SyntaxKind.LastAssignment;
}
Expand Down
58 changes: 58 additions & 0 deletions tests/baselines/reference/literalTypeProperty.errors.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
tests/cases/conformance/types/literal/literalTypeProperty.ts(7,1): error TS2743: The literal type '10' cannot be modified.
tests/cases/conformance/types/literal/literalTypeProperty.ts(8,1): error TS2743: The literal type '10' cannot be modified.
tests/cases/conformance/types/literal/literalTypeProperty.ts(9,1): error TS2743: The literal type '10' cannot be modified.
tests/cases/conformance/types/literal/literalTypeProperty.ts(10,1): error TS2743: The literal type '10' cannot be modified.
tests/cases/conformance/types/literal/literalTypeProperty.ts(11,3): error TS2743: The literal type '10' cannot be modified.
tests/cases/conformance/types/literal/literalTypeProperty.ts(12,3): error TS2743: The literal type '10' cannot be modified.
tests/cases/conformance/types/literal/literalTypeProperty.ts(14,1): error TS2743: The literal type '10 | 11' cannot be modified.
tests/cases/conformance/types/literal/literalTypeProperty.ts(15,1): error TS2743: The literal type '10 | 11' cannot be modified.
tests/cases/conformance/types/literal/literalTypeProperty.ts(16,1): error TS2743: The literal type '10 | 11' cannot be modified.
tests/cases/conformance/types/literal/literalTypeProperty.ts(17,1): error TS2743: The literal type '10 | 11' cannot be modified.
tests/cases/conformance/types/literal/literalTypeProperty.ts(18,3): error TS2743: The literal type '10 | 11' cannot be modified.
tests/cases/conformance/types/literal/literalTypeProperty.ts(19,3): error TS2743: The literal type '10 | 11' cannot be modified.


==== tests/cases/conformance/types/literal/literalTypeProperty.ts (12 errors) ====
declare class C {
foo: 10;
bar: 10 | 11
}

var o = new C()
o.foo ++
~~~~~
!!! error TS2743: The literal type '10' cannot be modified.
o.foo += 1
~~~~~
!!! error TS2743: The literal type '10' cannot be modified.
o.foo -= 1
~~~~~
!!! error TS2743: The literal type '10' cannot be modified.
o.foo --
~~~~~
!!! error TS2743: The literal type '10' cannot be modified.
++o.foo
~~~~~
!!! error TS2743: The literal type '10' cannot be modified.
--o.foo
~~~~~
!!! error TS2743: The literal type '10' cannot be modified.

o.bar ++
~~~~~
!!! error TS2743: The literal type '10 | 11' cannot be modified.
o.bar += 1
~~~~~
!!! error TS2743: The literal type '10 | 11' cannot be modified.
o.bar -= 1
~~~~~
!!! error TS2743: The literal type '10 | 11' cannot be modified.
o.bar --
~~~~~
!!! error TS2743: The literal type '10 | 11' cannot be modified.
++o.bar
~~~~~
!!! error TS2743: The literal type '10 | 11' cannot be modified.
--o.bar
~~~~~
!!! error TS2743: The literal type '10 | 11' cannot be modified.
35 changes: 35 additions & 0 deletions tests/baselines/reference/literalTypeProperty.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
//// [literalTypeProperty.ts]
declare class C {
foo: 10;
bar: 10 | 11
}

var o = new C()
o.foo ++
o.foo += 1
o.foo -= 1
o.foo --
++o.foo
--o.foo

o.bar ++
o.bar += 1
o.bar -= 1
o.bar --
++o.bar
--o.bar

//// [literalTypeProperty.js]
var o = new C();
o.foo++;
o.foo += 1;
o.foo -= 1;
o.foo--;
++o.foo;
--o.foo;
o.bar++;
o.bar += 1;
o.bar -= 1;
o.bar--;
++o.bar;
--o.bar;
75 changes: 75 additions & 0 deletions tests/baselines/reference/literalTypeProperty.symbols
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
=== tests/cases/conformance/types/literal/literalTypeProperty.ts ===
declare class C {
>C : Symbol(C, Decl(literalTypeProperty.ts, 0, 0))

foo: 10;
>foo : Symbol(C.foo, Decl(literalTypeProperty.ts, 0, 17))

bar: 10 | 11
>bar : Symbol(C.bar, Decl(literalTypeProperty.ts, 1, 10))
}

var o = new C()
>o : Symbol(o, Decl(literalTypeProperty.ts, 5, 3))
>C : Symbol(C, Decl(literalTypeProperty.ts, 0, 0))

o.foo ++
>o.foo : Symbol(C.foo, Decl(literalTypeProperty.ts, 0, 17))
>o : Symbol(o, Decl(literalTypeProperty.ts, 5, 3))
>foo : Symbol(C.foo, Decl(literalTypeProperty.ts, 0, 17))

o.foo += 1
>o.foo : Symbol(C.foo, Decl(literalTypeProperty.ts, 0, 17))
>o : Symbol(o, Decl(literalTypeProperty.ts, 5, 3))
>foo : Symbol(C.foo, Decl(literalTypeProperty.ts, 0, 17))

o.foo -= 1
>o.foo : Symbol(C.foo, Decl(literalTypeProperty.ts, 0, 17))
>o : Symbol(o, Decl(literalTypeProperty.ts, 5, 3))
>foo : Symbol(C.foo, Decl(literalTypeProperty.ts, 0, 17))

o.foo --
>o.foo : Symbol(C.foo, Decl(literalTypeProperty.ts, 0, 17))
>o : Symbol(o, Decl(literalTypeProperty.ts, 5, 3))
>foo : Symbol(C.foo, Decl(literalTypeProperty.ts, 0, 17))

++o.foo
>o.foo : Symbol(C.foo, Decl(literalTypeProperty.ts, 0, 17))
>o : Symbol(o, Decl(literalTypeProperty.ts, 5, 3))
>foo : Symbol(C.foo, Decl(literalTypeProperty.ts, 0, 17))

--o.foo
>o.foo : Symbol(C.foo, Decl(literalTypeProperty.ts, 0, 17))
>o : Symbol(o, Decl(literalTypeProperty.ts, 5, 3))
>foo : Symbol(C.foo, Decl(literalTypeProperty.ts, 0, 17))

o.bar ++
>o.bar : Symbol(C.bar, Decl(literalTypeProperty.ts, 1, 10))
>o : Symbol(o, Decl(literalTypeProperty.ts, 5, 3))
>bar : Symbol(C.bar, Decl(literalTypeProperty.ts, 1, 10))

o.bar += 1
>o.bar : Symbol(C.bar, Decl(literalTypeProperty.ts, 1, 10))
>o : Symbol(o, Decl(literalTypeProperty.ts, 5, 3))
>bar : Symbol(C.bar, Decl(literalTypeProperty.ts, 1, 10))

o.bar -= 1
>o.bar : Symbol(C.bar, Decl(literalTypeProperty.ts, 1, 10))
>o : Symbol(o, Decl(literalTypeProperty.ts, 5, 3))
>bar : Symbol(C.bar, Decl(literalTypeProperty.ts, 1, 10))

o.bar --
>o.bar : Symbol(C.bar, Decl(literalTypeProperty.ts, 1, 10))
>o : Symbol(o, Decl(literalTypeProperty.ts, 5, 3))
>bar : Symbol(C.bar, Decl(literalTypeProperty.ts, 1, 10))

++o.bar
>o.bar : Symbol(C.bar, Decl(literalTypeProperty.ts, 1, 10))
>o : Symbol(o, Decl(literalTypeProperty.ts, 5, 3))
>bar : Symbol(C.bar, Decl(literalTypeProperty.ts, 1, 10))

--o.bar
>o.bar : Symbol(C.bar, Decl(literalTypeProperty.ts, 1, 10))
>o : Symbol(o, Decl(literalTypeProperty.ts, 5, 3))
>bar : Symbol(C.bar, Decl(literalTypeProperty.ts, 1, 10))

92 changes: 92 additions & 0 deletions tests/baselines/reference/literalTypeProperty.types
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
=== tests/cases/conformance/types/literal/literalTypeProperty.ts ===
declare class C {
>C : C

foo: 10;
>foo : 10

bar: 10 | 11
>bar : 10 | 11
}

var o = new C()
>o : C
>new C() : C
>C : typeof C

o.foo ++
>o.foo ++ : number
>o.foo : number
>o : C
>foo : number

o.foo += 1
>o.foo += 1 : number
>o.foo : number
>o : C
>foo : number
>1 : 1

o.foo -= 1
>o.foo -= 1 : number
>o.foo : number
>o : C
>foo : number
>1 : 1

o.foo --
>o.foo -- : number
>o.foo : number
>o : C
>foo : number

++o.foo
>++o.foo : number
>o.foo : number
>o : C
>foo : number

--o.foo
>--o.foo : number
>o.foo : number
>o : C
>foo : number

o.bar ++
>o.bar ++ : number
>o.bar : number
>o : C
>bar : number

o.bar += 1
>o.bar += 1 : number
>o.bar : number
>o : C
>bar : number
>1 : 1

o.bar -= 1
>o.bar -= 1 : number
>o.bar : number
>o : C
>bar : number
>1 : 1

o.bar --
>o.bar -- : number
>o.bar : number
>o : C
>bar : number

++o.bar
>++o.bar : number
>o.bar : number
>o : C
>bar : number

--o.bar
>--o.bar : number
>o.bar : number
>o : C
>bar : number

Loading