Compilation hangs when using Bluebird promise library

[wtrocki]

Introduction

Passing bluebird promise from top level application to separate node.js module causing typescript compiler to hang until it gets out of memory. Problem is happening with multiple typescript compiler versions.

Using promises within the same npm module do not cause any of this problems.

** Environment **
TypeScript Version: Version 2.4.1
Latest bluebird library:

@types/bluebird: "^3.5.5",
bluebird: "^3.5.0",

Code
Simplified example:

// index.ts (separate npm module)
import * as Promise from 'bluebird';
export function init(test: Promise<object>){
      // Code
}

// App using module
import {init} from 'extmodule';
init(promise);

Expected behavior:
Code should compile.

Actual behavior:
Compilation process hangs with extensive memory and processor usage.

[wtrocki]

This problem may be related with Promise being available globally as native promise. Naming bluebird promise imported variable as Promise may just clash with global name. This is causing typescript compiler to end up with infinite loop until entire process gets out of memory.

Another option may be related with BlueBird type definition:
https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/bluebird/index.d.ts#L71-L76

Progress

• I'm going to create sample application to reproduce problem without domain specific code.
• Try to use different versions of BlueBird types to see if problem was introduced in BlueBird types
• Debug compiler to see what part is responsible for extensive memory usage.

[manojmkhanna]

I just stumbled upon the same problem. Using import * as Bluebird from "bluebird"; also doesn't seem to fix the problem. Is there a better way in solving this?

[manojmkhanna]

I have found a more simpler way to reproduce the bug.

Here's the debug repository https://github.com/manojkhannakm/typescript-bluebird-debug.

The repository has two modules module-a and module-b.

module-a has a class called A that has a method createPromise() which returns a Promise.

module-b uses module-a as a local dependency. module-b has a class called B which extends class A. Class B overrides class A's createPromise() method, this is the reason for the the compilation hang.

When running tsc on module-b, after about 5 mins I get this error.

> cd module-b
> tsc

<--- Last few GCs --->

[8912:00000150D2F48250]   223021 ms: Mark-sweep 1409.3 (1533.5) -> 1409.3 (1533.5) MB, 1748.3 / 0.0
ms  last resort


<--- JS stacktrace --->

==== JS stack trace =========================================

Security context: 0000006A6DC9BBE9 <JS Object>
    1: instantiateTypeNoAlias [C:\Users\Manoj Khanna\AppData\Roaming\npm\node_modules\typescript\lib
\tsc.js:~28453] [pc=000001746FFA31F8](this=00000147F3678919 <JS Global Object>,type=000000E45F43CFD1
 <a Type with map 0000016075EF79F9>,mapper=00000127FEF952E9 <JS Function mapper (SharedFunctionInfo
0000036127084DA1)>)
    2: getTypeOfInstantiatedSymbol [C:\Users\Manoj Khanna\AppData\Roaming\n...

FATAL ERROR: CALL_AND_RETRY_LAST Allocation failed - JavaScript heap out of memory

All I can think of is that the compiler is stuck in a loop in finding the definition for bluebird in class B.

On removing @types/bluebird and "strict": true from tsconfig on module-b the compilation is successful.

Also I found that publishing module-a to the npm registry and using it in module-b as a public dependency compiles just fine. So the problem occurs only when using module-a as a local dependency.

[sandersn]

@manojkhannakm can you give more detail on your repro? I tried git clone ...; cd module-a; npm i; cd ../module-b; npm i; tsc but I then get the error "cannot find 'module-a'." This doesn't surprise me too much because I don't see any path mapping in tsconfig. When I change module-b's tsconfig, compilation succeeds.

Here's my modified tsconfig. I'm not sure path mapping is the right thing to represent a local dependency from npm. And I had to remove rootDir to get compilation to succeed as well.

{
  "compilerOptions": {
    "module": "commonjs",
    "target": "es6",
    "baseUrl": ".",
    "paths": {
      "module-a": ["../module-a/src"]
    },
    "outDir": "./dist",
    "strict": true,
    "declaration": true,
    "sourceMap": true
  }
}

[sandersn]

@wtrocki I can't repro the crash with your example either. Note that I changed the first line of app/src/index.ts to import {BaseClass} from 'ts-bluebird-module'; since it couldn't find the module 'ts-module'.

[manojmkhanna]

@sandersn I think you missed running tsc on module-a that's why you got Cannot find module 'module-a'.

Also I just tried again with your tsconfig but the compilation still timeouts on module-b.

Edit:

Got this after about 5mins.

C:/Users/Manoj Khanna/Desktop/typescript-bluebird-debug/module-b master
❯ tsc

<--- Last few GCs --->

[3688:000001C7AB5E8A30]   136990 ms: Mark-sweep 1406.2 (1531.5) -> 1406.2 (1531.5) MB, 1432.1 / 0.0
ms  last resort


<--- JS stacktrace --->

==== JS stack trace =========================================

Security context: 000002DBF781BBE9 <JS Object>
    2: findAncestor [C:\Users\Manoj Khanna\AppData\Roaming\npm\node_modules\typescript\lib\tsc.js:~3
07] [pc=000000A8A062963F](this=000002BA5A40B0D1 <an Object with map 0000027EAACE5D59>,node=000002860
9866499 <a Node with map 0000027EAACF8EF1>,callback=0000022696E153A1 <JS Function (SharedFunctionInf
o 000001F1F32EAE61)>)
    3: isSymbolInScopeOfMappedTypeParameter [C:\Users\Manoj Khanna\AppDat...

FATAL ERROR: CALL_AND_RETRY_LAST Allocation failed - JavaScript heap out of memory