microsoft / microsoft/TypeScript

Suggestion: execute property initializer expressions at the expected time

Open
#7,738 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Committed Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

Currently, TS moves property initializers in a way that can be suprising and lead to subtle problems. Eg, Issue #7644, but I've seen it in other places. Another example which I ran into in a PL class (while trying to demonstrate something else...):

let y = 1;
class Foo {
    private x = y;
    constructor(y) {
    }
}

The error message for this is confusing, but IMO it is expected since it's the behavior of these things that is confusing. That's a result of moving the expressions into a different scope than the original source and also a different time (in the constructor call instead of when the class is generated).

So I think that it would be much better (and solve a bunch of issues around this area) if the emitted code would evaluate the initializer expressions at a proper time, for example, producing this code for the above:

var y = 1;
var Foo = (function () {
    var _y_init = y;
    function Foo(y) {
        this.x = _y_init;
    }
    return Foo;
}());

I'm gussing that (some of) the reasons to not do that are being able to refer to this in these expressions, and the fact that you get values that are shared for all instances (eg, with a private x = {} initializer). Personally, I'd argue that neither of these is worth keeping: before I dug into this I assumed that a {} value would be shared, and I never considered using this. on the RHS, since I automatically didn't assume that there exists one that can be used.

But assuming that it's hopeless to fix this completely (since it'd break code in subtle and potentially disastrous ways), so the unexpected (for me) execution order must stick. But the scope breakage is more subtle and more important, so how about fixing just that with something like:

var y = 1;
var Foo = (function () {
    function _init(_this) {
        _this.x = y;
    }
    function Foo(y) {
        _init(this);
    }
    return Foo;
}());

And it would be nice if such an _init thing is consistently done after a super() when there is one, since the time when these expressions are evaluated is changed anyway, there's no reason for people to expect them to happen before a super (and such an expectation now is unreliable since the initialization happens, AFAICT, either before or after a super).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No source files or tests are named. Start by tracing the compiler path that lowers class property initializers, then compare emitted JavaScript for the examples in this issue, including derived classes and references to this. Done would require an agreed evaluation order and scope behavior without breaking existing initializer semantics.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
compilers
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.