fix(54760): Report error for 'declare type' followed by newline #54761

strager · 2023-06-24T03:18:39Z

The following TypeScript code does not report a diagnostic. Instead, the TypeScript copmiler parses the code as if ASI was applied between two tokens on the same line:

var declare, type, T;

declare /*ASI*/ type /*ASI*/
T = null;

I think this behavior is confusing. TypeScript v4.3.5 used to report a diagnostic for this code, which I think is better than the current behavior of allowing this code without any diagnostic.

Instead of performing ASI between 'declare' and 'type', report a diagnostic telling the user that a newline shouldn't be written after 'type'.

Fixes #54760

The following TypeScript code does not report a diagnostic. Instead, the TypeScript copmiler parses the code as if ASI was applied between two tokens on the same line: var declare, type, T; declare /*ASI*/ type /*ASI*/ T = null; I think this behavior is confusing. TypeScript v4.3.5 used to report a diagnostic for this code, which I think is better than the current behavior of allowing this code without any diagnostic. Instead of performing ASI between 'declare' and 'type', report a diagnostic telling the user that a newline shouldn't be written after 'type'.

strager · 2023-06-24T03:19:48Z

tests/baselines/reference/typeAliasDeclareKeywordNewlines.errors.txt

+    declare type /*unexpected newline*/
+    T1 = null;
+    ~~
+!!! error TS1142: Line break not permitted here.


Question for reviewers: I don't like the placement of the diagnostic, but I don't know TypeScript diagnostic conventions. Is here fine or should it point to the type keyword on the previous line?

You can give a specialized diagnostic, but I think this is actually fine as-is.

DanielRosenwasser · 2023-06-26T20:31:21Z

This looks good but...shouldn't there be a .types and .symbols baseline generated? Any ideas @weswigham @sandersn?

jakebailey · 2023-06-26T20:32:59Z

This looks good but...shouldn't there be a .types and .symbols baseline generated?

The test has // @noTypesAndSymbols: true set since it's just testing the parser.

DanielRosenwasser · 2023-06-26T20:38:35Z

Ah - maybe I'm being a stickler, but if we turn that off and switch the line to

- var declare, type, T;
+ var declare: string, type: number, T: boolean;

we can get a slightly better sense of how TypeScript itself is parsing.

It would also be good to detect whether or not T1 and T2 can be resolved correctly.

+ var x: T1, y: T2;

strager · 2023-06-27T03:09:33Z

It would also be good to detect whether or not T1 and T2 can be resolved correctly.

Good idea. I updated this pull request. I also included an explanation for each test case.

DanielRosenwasser

Looks good! Though you'll need to accept baselines.

DanielRosenwasser · 2023-06-27T05:12:12Z

src/compiler/parser.ts

@@ -7093,13 +7093,20 @@ namespace Parser {
                case SyntaxKind.PrivateKeyword:
                case SyntaxKind.ProtectedKeyword:
                case SyntaxKind.PublicKeyword:
-                case SyntaxKind.ReadonlyKeyword:
+                case SyntaxKind.ReadonlyKeyword: {


Nit: I know it helps with scope hygiene, but since the rest of the codebase avoids it, I'd rather we didn't add braces unless necessary.

Suggested change

case SyntaxKind.ReadonlyKeyword: {

case SyntaxKind.ReadonlyKeyword:

DanielRosenwasser · 2023-06-27T05:12:28Z

src/compiler/parser.ts

                    continue;
+                }


Suggested change

}

tests/cases/compiler/typeAliasDeclareKeywordNewlines.ts

strager · 2023-07-18T19:22:51Z

It looks like this pull request was approved. When can I expect it to be merged?

jakebailey

LGTM but I would probably consider making that change suggested by Daniel.

Usually it's the assignee that drives a PR to completion but I'm happy to click the button for parser changes like this.

jakebailey · 2023-07-18T23:29:19Z

@strager If you don't have the time to make the change, I'm happy to push it onto the PR.

Also add some comments.

jakebailey · 2023-07-19T18:03:19Z

Almost forgot

@typescript-bot test this
@typescript-bot test top100
@typescript-bot user test this
@typescript-bot run dt
@typescript-bot perf test this faster

typescript-bot · 2023-07-19T18:03:22Z

Heya @jakebailey, I've started to run the diff-based user code test suite on this PR at f2190c4. You can monitor the build here.

Update: The results are in!

typescript-bot · 2023-07-19T18:03:22Z

Heya @jakebailey, I've started to run the parallelized Definitely Typed test suite on this PR at f2190c4. You can monitor the build here.

Update: The results are in!

typescript-bot · 2023-07-19T18:03:22Z

Heya @jakebailey, I've started to run the diff-based top-repos suite on this PR at f2190c4. You can monitor the build here.

Update: The results are in!

typescript-bot · 2023-07-19T18:03:22Z

Heya @jakebailey, I've started to run the abridged perf test suite on this PR at f2190c4. You can monitor the build here.

Update: The results are in!

typescript-bot · 2023-07-19T18:03:22Z

Heya @jakebailey, I've started to run the extended test suite on this PR at f2190c4. You can monitor the build here.

typescript-bot · 2023-07-19T18:18:58Z

@jakebailey
The results of the perf run you requested are in!

Here they are:

Comparison Report - main..54761

_Metric	_main	₅₄₇₆₁	_Delta	_Best	_Worst	_p-value
_{Angular - node (v16.17.1, x64)}
_{Memory used}	_{366,178k (± 0.00%)}	_{366,200k (± 0.00%)}	_{+22k (+ 0.01%)}	_366,178k	_366,214k	_{p=0.031 n=6}
_{Parse Time}	_{3.56s (± 0.37%)}	_{3.55s (± 0.68%)}	_~	_3.52s	_3.58s	_{p=0.935 n=6}
_{Bind Time}	_{1.19s (± 0.63%)}	_{1.18s (± 0.69%)}	_~	_1.17s	_1.19s	_{p=0.383 n=6}
_{Check Time}	_{9.64s (± 0.15%)}	_{9.70s (± 0.59%)}	_~	_9.63s	_9.79s	_{p=0.076 n=6}
_{Emit Time}	_{7.92s (± 0.47%)}	_{7.99s (± 0.61%)}	_{+0.07s (+ 0.86%)}	_7.94s	_8.08s	_{p=0.024 n=6}
_{Total Time}	_{22.31s (± 0.14%)}	_{22.42s (± 0.40%)}	_{+0.11s (+ 0.50%)}	_22.31s	_22.54s	_{p=0.036 n=6}
_{Compiler-Unions - node (v16.17.1, x64)}
_{Memory used}	_{192,911k (± 0.04%)}	_{194,027k (± 0.87%)}	_~	_192,889k	_196,314k	_{p=0.261 n=6}
_{Parse Time}	_{1.58s (± 1.44%)}	_{1.60s (± 0.65%)}	_~	_1.58s	_1.61s	_{p=0.249 n=6}
_{Bind Time}	_{0.82s (± 0.92%)}	_{0.83s (± 0.66%)}	_~	_0.82s	_0.83s	_{p=0.476 n=6}
_{Check Time}	_{10.11s (± 0.96%)}	_{10.16s (± 0.52%)}	_~	_10.07s	_10.21s	_{p=0.335 n=6}
_{Emit Time}	_{3.00s (± 0.83%)}	_{3.01s (± 0.78%)}	_~	_2.98s	_3.04s	_{p=0.871 n=6}
_{Total Time}	_{15.52s (± 0.60%)}	_{15.59s (± 0.32%)}	_~	_15.53s	_15.66s	_{p=0.108 n=6}
_{Monaco - node (v16.17.1, x64)}
_{Memory used}	_{346,172k (± 0.00%)}	_{346,185k (± 0.00%)}	_~	_346,160k	_346,207k	_{p=0.128 n=6}
_{Parse Time}	_{2.76s (± 0.46%)}	_{2.77s (± 0.38%)}	_~	_2.76s	_2.79s	_{p=0.071 n=6}
_{Bind Time}	_{1.08s (± 0.48%)}	_{1.08s (± 0.51%)}	_~	_1.07s	_1.08s	_{p=0.640 n=6}
_{Check Time}	_{7.98s (± 0.24%)}	_{8.01s (± 0.46%)}	_~	_7.97s	_8.07s	_{p=0.222 n=6}
_{Emit Time}	_{4.43s (± 0.22%)}	_{4.45s (± 0.24%)}	_~	_4.43s	_4.46s	_{p=0.066 n=6}
_{Total Time}	_{16.25s (± 0.19%)}	_{16.30s (± 0.26%)}	_~	_16.25s	_16.36s	_{p=0.106 n=6}
_{TFS - node (v16.17.1, x64)}
_{Memory used}	_{300,242k (± 0.01%)}	_{300,227k (± 0.01%)}	_~	_300,193k	_300,255k	_{p=0.423 n=6}
_{Parse Time}	_{2.19s (± 0.37%)}	_{2.21s (± 0.37%)}	_{+0.03s (+ 1.22%)}	_2.20s	_2.22s	_{p=0.006 n=6}
_{Bind Time}	_{1.20s (± 0.97%)}	_{1.20s (± 1.18%)}	_~	_1.18s	_1.22s	_{p=0.934 n=6}
_{Check Time}	_{7.30s (± 0.37%)}	_{7.30s (± 0.44%)}	_~	_7.26s	_7.35s	_{p=1.000 n=6}
_{Emit Time}	_{4.34s (± 0.43%)}	_{4.36s (± 0.78%)}	_~	_4.32s	_4.40s	_{p=0.182 n=6}
_{Total Time}	_{15.03s (± 0.26%)}	_{15.08s (± 0.37%)}	_~	_15.02s	_15.17s	_{p=0.077 n=6}
_{material-ui - node (v16.17.1, x64)}
_{Memory used}	_{481,669k (± 0.01%)}	_{481,645k (± 0.01%)}	_~	_481,564k	_481,712k	_{p=0.810 n=6}
_{Parse Time}	_{3.24s (± 0.53%)}	_{3.25s (± 0.13%)}	_~	_3.24s	_3.25s	_{p=0.731 n=6}
_{Bind Time}	_{0.95s (± 1.23%)}	_{0.96s (± 0.85%)}	_~	_0.95s	_0.97s	_{p=0.666 n=6}
_{Check Time}	_{18.37s (± 1.16%)}	_{18.34s (± 0.45%)}	_~	_18.26s	_18.49s	_{p=0.936 n=6}
_{Emit Time}	_{0.00s (± 0.00%)}	_{0.00s (± 0.00%)}	_~	_0.00s	_0.00s	_{p=1.000 n=6}
_{Total Time}	_{22.57s (± 1.00%)}	_{22.55s (± 0.40%)}	_~	_22.46s	_22.71s	_{p=0.872 n=6}
_{xstate - node (v16.17.1, x64)}
_{Memory used}	_{561,279k (± 0.02%)}	_{561,303k (± 0.02%)}	_~	_561,137k	_561,493k	_{p=0.689 n=6}
_{Parse Time}	_{4.01s (± 0.30%)}	_{4.02s (± 0.34%)}	_~	_4.01s	_4.04s	_{p=0.176 n=6}
_{Bind Time}	_{1.74s (± 4.52%)}	_{1.71s (± 5.88%)}	_~	_1.58s	_1.79s	_{p=0.742 n=6}
_{Check Time}	_{3.09s (± 2.76%)}	_{3.09s (± 1.26%)}	_~	_3.06s	_3.14s	_{p=0.567 n=6}
_{Emit Time}	_{0.09s (± 8.51%)}	_{0.09s (± 4.62%)}	_~	_0.08s	_0.09s	_{p=0.730 n=6}
_{Total Time}	_{8.94s (± 0.15%)}	_{8.92s (± 0.82%)}	_~	_8.82s	_8.99s	_{p=1.000 n=6}

System

_{Machine Name}	_ts-ci-ubuntu
_Platform	_{linux 5.4.0-148-generic}
_Architecture	_x64
_{Available Memory}	_{16 GB}
_{Available Memory}	_{15 GB}
_CPUs	_{4 × Intel(R) Core(TM) i7-4770 CPU @ 3.40GHz}

Hosts

node (v16.17.1, x64)

Scenarios

Angular - node (v16.17.1, x64)
Compiler-Unions - node (v16.17.1, x64)
Monaco - node (v16.17.1, x64)
TFS - node (v16.17.1, x64)
material-ui - node (v16.17.1, x64)
xstate - node (v16.17.1, x64)

_Benchmark	_Name	_Iterations
_Current	₅₄₇₆₁	₆
_Baseline	_main	₆

Developer Information:

Download Benchmark

typescript-bot · 2023-07-19T18:27:22Z

@jakebailey Here are the results of running the user test suite comparing main and refs/pull/54761/merge:

There were infrastructure failures potentially unrelated to your change:

1 instance of "Unknown failure"
1 instance of "Package install failed"

Otherwise...

Something interesting changed - please have a look.

Details

rxjs-src

/mnt/ts_downloads/rxjs-src/build.sh

[NEW] error TS2428: All declarations of 'WeakMap' must have identical type parameters.
- /home/vsts/work/1/s/typescript-54761/lib/lib.es2015.collection.d.ts(63,11)
- /home/vsts/work/1/s/typescript-54761/lib/lib.es2015.iterable.d.ts(162,11)
- /home/vsts/work/1/s/typescript-54761/lib/lib.es2015.symbol.wellknown.d.ts(140,11)
- /home/vsts/work/1/s/typescript-54761/lib/lib.es2015.collection.d.ts(63,11)
- /home/vsts/work/1/s/typescript-54761/lib/lib.es2015.iterable.d.ts(162,11)
- /home/vsts/work/1/s/typescript-54761/lib/lib.es2015.symbol.wellknown.d.ts(140,11)
- /home/vsts/work/1/s/typescript-54761/lib/lib.es2015.collection.d.ts(63,11)
- /home/vsts/work/1/s/typescript-54761/lib/lib.es2015.iterable.d.ts(162,11)
- /home/vsts/work/1/s/typescript-54761/lib/lib.es2015.symbol.wellknown.d.ts(140,11)
- /home/vsts/work/1/s/typescript-54761/lib/lib.es2015.collection.d.ts(63,11)
- /home/vsts/work/1/s/typescript-54761/lib/lib.es2015.iterable.d.ts(162,11)
- /home/vsts/work/1/s/typescript-54761/lib/lib.es2015.symbol.wellknown.d.ts(140,11)
- /home/vsts/work/1/s/typescript-54761/lib/lib.es2015.collection.d.ts(63,11)
- /home/vsts/work/1/s/typescript-54761/lib/lib.es2015.iterable.d.ts(162,11)
- /home/vsts/work/1/s/typescript-54761/lib/lib.es2015.symbol.wellknown.d.ts(140,11)
[MISSING] error TS2428: All declarations of 'WeakMap' must have identical type parameters.
- /home/vsts/work/1/s/typescript-main/lib/lib.es2015.collection.d.ts(63,11)
- /home/vsts/work/1/s/typescript-main/lib/lib.es2015.iterable.d.ts(162,11)
- /home/vsts/work/1/s/typescript-main/lib/lib.es2015.symbol.wellknown.d.ts(140,11)
- /home/vsts/work/1/s/typescript-main/lib/lib.es2015.collection.d.ts(63,11)
- /home/vsts/work/1/s/typescript-main/lib/lib.es2015.iterable.d.ts(162,11)
- /home/vsts/work/1/s/typescript-main/lib/lib.es2015.symbol.wellknown.d.ts(140,11)
- /home/vsts/work/1/s/typescript-main/lib/lib.es2015.collection.d.ts(63,11)
- /home/vsts/work/1/s/typescript-main/lib/lib.es2015.iterable.d.ts(162,11)
- /home/vsts/work/1/s/typescript-main/lib/lib.es2015.symbol.wellknown.d.ts(140,11)
- /home/vsts/work/1/s/typescript-main/lib/lib.es2015.collection.d.ts(63,11)
- /home/vsts/work/1/s/typescript-main/lib/lib.es2015.iterable.d.ts(162,11)
- /home/vsts/work/1/s/typescript-main/lib/lib.es2015.symbol.wellknown.d.ts(140,11)
- /home/vsts/work/1/s/typescript-main/lib/lib.es2015.collection.d.ts(63,11)
- /home/vsts/work/1/s/typescript-main/lib/lib.es2015.iterable.d.ts(162,11)
- /home/vsts/work/1/s/typescript-main/lib/lib.es2015.symbol.wellknown.d.ts(140,11)

typescript-bot · 2023-07-19T19:45:18Z

@jakebailey Here are the results of running the top-repos suite comparing main and refs/pull/54761/merge:

Everything looks good!

typescript-bot · 2023-07-19T20:13:00Z

Hey @jakebailey, the results of running the DT tests are ready.
Everything looks the same!
You can check the log here.

jakebailey

Alright, seems good to me; hopefully this isn't too bandaid-y, given the very similar issue #54760 bisected to the same problematic PR (#43005), but I suspect they wouldn't have similar fixes anyway.

typescript-bot added the For Uncommitted Bug PR for untriaged, rejected, closed or missing bug label Jun 24, 2023

strager commented Jun 24, 2023

View reviewed changes

Enable type checking in test and add more documentation and assertions

831fad4

typescript-bot assigned rbuckton Jun 27, 2023

typescript-bot added For Milestone Bug PRs that fix a bug with a specific milestone and removed For Uncommitted Bug PR for untriaged, rejected, closed or missing bug labels Jun 27, 2023

DanielRosenwasser approved these changes Jun 27, 2023

View reviewed changes

DanielRosenwasser requested a review from jakebailey June 27, 2023 05:14

DanielRosenwasser reviewed Jun 27, 2023

View reviewed changes

tests/cases/compiler/typeAliasDeclareKeywordNewlines.ts Outdated Show resolved Hide resolved

strager added 3 commits June 28, 2023 18:29

Update test baselines

894120d

Remove unnecessary code block

72502bc

Add missing test baseline files

63af658

jakebailey approved these changes Jul 18, 2023

View reviewed changes

Use different, specific types for helper variables

f2190c4

Also add some comments.

jakebailey approved these changes Jul 20, 2023

View reviewed changes

jakebailey merged commit e607c8e into microsoft:main Jul 20, 2023

	case SyntaxKind.ReadonlyKeyword: {
	case SyntaxKind.ReadonlyKeyword:

fix(54760): Report error for 'declare type' followed by newline #54761

fix(54760): Report error for 'declare type' followed by newline #54761

Uh oh!

Conversation

strager commented Jun 24, 2023

Uh oh!

strager Jun 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DanielRosenwasser Jun 26, 2023

Choose a reason for hiding this comment

Uh oh!

DanielRosenwasser commented Jun 26, 2023

Uh oh!

jakebailey commented Jun 26, 2023

Uh oh!

DanielRosenwasser commented Jun 26, 2023

Uh oh!

strager commented Jun 27, 2023

Uh oh!

DanielRosenwasser left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DanielRosenwasser Jun 27, 2023

Choose a reason for hiding this comment

Uh oh!

DanielRosenwasser Jun 27, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

strager commented Jul 18, 2023

Uh oh!

jakebailey left a comment

Choose a reason for hiding this comment

Uh oh!

jakebailey commented Jul 18, 2023

Uh oh!

jakebailey commented Jul 19, 2023

Uh oh!

typescript-bot commented Jul 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

typescript-bot commented Jul 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

typescript-bot commented Jul 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

typescript-bot commented Jul 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

typescript-bot commented Jul 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

typescript-bot commented Jul 19, 2023

Uh oh!

typescript-bot commented Jul 19, 2023

rxjs-src

/mnt/ts_downloads/rxjs-src/build.sh

Uh oh!

typescript-bot commented Jul 19, 2023

Uh oh!

typescript-bot commented Jul 19, 2023

Uh oh!

jakebailey left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

strager Jun 24, 2023 •

edited

Loading

DanielRosenwasser left a comment •

edited

Loading

typescript-bot commented Jul 19, 2023 •

edited

Loading

typescript-bot commented Jul 19, 2023 •

edited

Loading

typescript-bot commented Jul 19, 2023 •

edited

Loading

typescript-bot commented Jul 19, 2023 •

edited

Loading

typescript-bot commented Jul 19, 2023 •

edited

Loading