try-finally causes "variable is used before being assigned"

[screendriver]

TypeScript Version: 3.5.3

Search Terms:

• variable is used before being assigned
• try finally variable

Code

function bug() {
  let close: () => void | undefined;
  if (process.env.NODE_ENV === 'development') {
    close = () => {}
  }
  try {
    // ...
  } finally {
    if (close) { // Variable 'close' is used before being assigned.ts(2454)
      close()
    }
  }
}

Expected behavior:

Should compile without errors

Actual behavior:

Does not compile: Variable 'close' is used before being assigned.ts(2454)

Playground Link:

http://www.typescriptlang.org/play/index.html#code/GYVwdgxgLglg9mABAIxAcwBQEpEG8BQiiANgKZSITFwDOpAXItogLwB8iAbnDACYDchRDGBMADgCc4EUjRoA6UmE7yAcgHkAIgFEA+ttUA1VixaIA5L1KdS1MQFslUczgJEiVWqVZMc7PAC+QkFEUBIAnnhCRAD0MYjyicGIwDBgAIbExJFu7iJMnnSu0e6FpNglIYhBAUA

Related Issues:

#29684
#12205
#12355

[MartinJohns]

You are using it before being assigned in all code paths. If process.env.NODE_ENV === 'development' evaluates to false you never assign any value to close. This issue is completely unrelated to the try-finally block.

[poseidonCore]

For context, this occurs in this case when strictNullChecks is on. Otherwise, not.

[DanielRosenwasser]

You need to parenthesize your function type. This will fix it.

- let close: () => void | undefined;
+ let close: (() => void) | undefined;

[screendriver]

This issue is completely unrelated to the try-finally block.

while that's true

You are using it before being assigned in all code paths

this is not 100% true. What I wrote is still valid JavaScript and TypeScript usually checks such conditions in branches. I wrote an explicit if-statement that checks for undefined in that case.

What's really interesting is that when I change the type from a function to for example a string it works:

function bug() {
  let test: string | undefined; // does not work with () => void | undefined
  if (process.env.NODE_ENV === 'development') {
    test = 'bar'
  }
  if (test) {
    // works 👍 
  }
}

and as function arguments it works also:

function bug(close?: () => void) {
  if (process.env.NODE_ENV === 'development') {
    close = () => {}
  }
  try {
    // ...
  } finally {
    if (close) { // works 👍 
      close()
    }
  }
}

[DanielRosenwasser]

If you mark something as potentially undefined, it will allow you to use it without initialization. That's why #32836 (comment) should address the issue.

[screendriver]

You need to parenthesize your function type. This will fix it.

- let close: () => void | undefined;
+ let close: (() => void) | undefined;

Oh, damn! 🤦‍♂ How embarrassing that I overlooked that. Sometimes you do not see the forest for the trees

[DanielRosenwasser]

To be honest it just sort of stinks that we don't provide a better error message or something there.

[screendriver]

That would be awesome. After hours of coding such a small typo sometimes leads to a total 🤯

[DanielRosenwasser]

See #32846.

[screendriver]

Great. I already gave my 👍 and subscribed 😎

At the moment I am thinking about if it would be possible that something like this let close: () => void; automatically has an inferred union type of (() => void) | undefined because nothing is assigned at the moment. So it must be initially undefined. What do you think Daniel Rosenwasser (@DanielRosenwasser) ? With that you don't have to explicitly annotate it with (() => void) | undefined

[DanielRosenwasser]

The problem with that is that until an assignment occurs, the narrowed type would be undefined, allowing you to pass it in to optional parameters of unrelated types. That might be undesirable, so requiring an explicit | undefined helps make the intent clearer.

P.S. I'm on mobile, so I'm sort of guessing the behavior from memory.

[screendriver]

so requiring an explicit | undefined helps make the intent clearer

True. But it's a little bit annoying to always type an | undefined ☺️ Mabey a let close?: () => void; like in function arguments would be cool 😉