![]() It is possible for the sub-process responsible for running a NodeJS Pulumi program to exit with a success code before the user's program has run if the process of loading the runtime generates an unhandled promise rejection. These changes fix this by registering the unhandled exception and rejection handlers that are responsible for ensuring a non-zero exit code in these cases before any other action is taken. Note that this issue is really only possible because the Node language host (like the Python language host) is composed of two processes: one that serves the language host gRPC service and one that loads and runs the user's program. The former launches the latter in response to a call to its `Run` gRPC endpoint. The lifetime of the user's program is considered to be bounded by the lifetime of the `Run` invocation. The NodeJS process maintains its own connection to the engine over which resource registrations are communicated. It is tempting to add a message to the resource monitor RPC interface that signals that no further registrations are performed, but this is complicated due to the three-party topology and the possibility that such an RPC may never be sent (e.g. due to a crash or a downlevel version of the Pulumi Node runtime). Fixes #2316. |
||
---|---|---|
.. | ||
asset | ||
cmd | ||
dist | ||
dynamic | ||
iterable | ||
log | ||
proto | ||
runtime | ||
tests | ||
.gitignore | ||
Makefile | ||
README.md | ||
config.ts | ||
errors.ts | ||
index.ts | ||
invoke.ts | ||
metadata.ts | ||
package.json | ||
resource.ts | ||
stackReference.ts | ||
tsconfig.json | ||
tslint.json | ||
version.ts |
README.md
Pulumi Node.js SDK
The Pulumi Node.js SDK lets you write cloud programs in JavaScript.
Installation
Using npm:
$ npm install --save @pulumi/pulumi
Using yarn:
$ yarn add @pulumi/pulumi
This SDK is meant for use with the Pulumi CLI. Please visit pulumi.io for installation instructions.
Building and Testing
For anybody who wants to build from source, here is how you do it.
Prerequisites
This SDK uses Node.js and we support the Active LTS and Current releases, as defined by this table. We support both NPM and Yarn for package management.
At the moment, we only support building on macOS and Linux, where standard GNU tools like make
are available.
Make Targets
The first time you build, run make ensure
to install and prepare native plugins for V8:
$ make ensure
This is only necessary if you intend to produce a build that is capable of running older versions of the SDK
contained in this directory. If you do intend to do this, you must have node 6.10.2
installed.
To build the SDK, simply run make
from the root directory (where this README
lives, at sdk/nodejs/
from the repo's
root). This will build the code, run tests, and install the package and its supporting artifacts.
At the moment, for local development, we install everything into /opt/pulumi
. You will want this on your $PATH
.
The tests will verify that everything works, but feel free to try running pulumi preview
and/or pulumi update
from
the examples/minimal/
directory. Remember to run tsc
first, since pulumi
expects JavaScript, not TypeScript.