[Snyk] Upgrade esbuild from 0.15.18 to 0.20.2 #3
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR was automatically created by Snyk using the credentials of a real user.
Snyk has created this PR to upgrade esbuild from 0.15.18 to 0.20.2.
ℹ️ Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project.
The recommended version is 75 versions ahead of your current version.
The recommended version was released 2 months ago, on 2024-03-14.
Release notes
Package name: esbuild
Support TypeScript experimental decorators on
abstract
class fields (#3684)With this release, you can now use TypeScript experimental decorators on
abstract
class fields. This was silently compiled incorrectly in esbuild 0.19.7 and below, and was an error from esbuild 0.19.8 to esbuild 0.20.1. Code such as the following should now work correctly:const log = (x: any, y: string) => console.log(y)
abstract class Foo { @log abstract foo: string }
new class extends Foo { foo = '' }
// Old output (with --loader=ts --tsconfig-raw={"compilerOptions":{"experimentalDecorators":true}})
const log = (x, y) => console.log(y);
class Foo {
}
new class extends Foo {
foo = "";
}();
// New output (with --loader=ts --tsconfig-raw={"compilerOptions":{"experimentalDecorators":true}})
const log = (x, y) => console.log(y);
class Foo {
}
__decorateClass([
log
], Foo.prototype, "foo", 2);
new class extends Foo {
foo = "";
}();
JSON loader now preserves
__proto__
properties (#3700)Copying JSON source code into a JavaScript file will change its meaning if a JSON object contains the
__proto__
key. A literal__proto__
property in a JavaScript object literal sets the prototype of the object instead of adding a property named__proto__
, while a literal__proto__
property in a JSON object literal just adds a property named__proto__
. With this release, esbuild will now work around this problem by converting JSON to JavaScript with a computed property key in this case:import data from 'data:application/json,{"proto":{"fail":true}}'
if (Object.getPrototypeOf(data)?.fail) throw 'fail'
// Old output (with --bundle)
(() => {
// <data:application/json,{"proto":{"fail":true}}>
var json_proto_fail_true_default = { proto: { fail: true } };
// entry.js
if (Object.getPrototypeOf(json_proto_fail_true_default)?.fail)
throw "fail";
})();
// New output (with --bundle)
(() => {
// <data:application/json,{"proto":{"fail":true}}>
var json_proto_fail_true_default = { ["proto"]: { fail: true } };
// example.mjs
if (Object.getPrototypeOf(json_proto_fail_true_default)?.fail)
throw "fail";
})();
Improve dead code removal of
switch
statements (#3659)With this release, esbuild will now remove
switch
statements in branches when minifying if they are known to never be evaluated:if (true) foo(); else switch (bar) { case 1: baz(); break }
// Old output (with --minify)
if(1)foo();else switch(bar){case 1:}
// New output (with --minify)
foo();
Empty enums should behave like an object literal (#3657)
TypeScript allows you to create an empty enum and add properties to it at run time. While people usually use an empty object literal for this instead of a TypeScript enum, esbuild's enum transform didn't anticipate this use case and generated
undefined
instead of{}
for an empty enum. With this release, you can now use an empty enum to generate an empty object literal.enum Foo {}
// Old output (with --loader=ts)
var Foo = /* @ PURE */ ((Foo2) => {
})(Foo || {});
// New output (with --loader=ts)
var Foo = /* @ PURE */ ((Foo2) => {
return Foo2;
})(Foo || {});
Handle Yarn Plug'n'Play edge case with
tsconfig.json
(#3698)Previously a
tsconfig.json
file thatextends
another file in a package with anexports
map failed to work when Yarn's Plug'n'Play resolution was active. This edge case should work now starting with this release.Work around issues with Deno 1.31+ (#3682)
Version 0.20.0 of esbuild changed how the esbuild child process is run in esbuild's API for Deno. Previously it used
Deno.run
but that API is being removed in favor ofDeno.Command
. As part of this change, esbuild is now calling the newunref
function on esbuild's long-lived child process, which is supposed to allow Deno to exit when your code has finished running even though the child process is still around (previously you had to explicitly call esbuild'sstop()
function to terminate the child process for Deno to be able to exit).However, this introduced a problem for Deno's testing API which now fails some tests that use esbuild with
error: Promise resolution is still pending but the event loop has already resolved
. It's unclear to me why this is happening. The call tounref
was recommended by someone on the Deno core team, and calling Node's equivalentunref
API has been working fine for esbuild in Node for a long time. It could be that I'm using it incorrectly, or that there's some reference counting and/or garbage collection bug in Deno's internals, or that Deno'sunref
just works differently than Node'sunref
. In any case, it's not good for Deno tests that use esbuild to be failing.In this release, I am removing the call to
unref
to fix this issue. This means that you will now have to call esbuild'sstop()
function to allow Deno to exit, just like you did before esbuild version 0.20.0 when this regression was introduced.Note: This regression wasn't caught earlier because Deno doesn't seem to fail tests that have outstanding
setTimeout
calls, which esbuild's test harness was using to enforce a maximum test runtime. Adding asetTimeout
was allowing esbuild's Deno tests to succeed. So this regression doesn't necessarily apply to all people using tests in Deno.Fix a bug with the CSS nesting transform (#3648)
This release fixes a bug with the CSS nesting transform for older browsers where the generated CSS could be incorrect if a selector list contained a pseudo element followed by another selector. The bug was caused by incorrectly mutating the parent rule's selector list when filtering out pseudo elements for the child rules:
.foo {
&:after,
& .bar {
color: red;
}
}
/* Old output (with --supported:nesting=false) */
.foo .bar,
.foo .bar {
color: red;
}
/* New output (with --supported:nesting=false) */
.foo:after,
.foo .bar {
color: red;
}
Constant folding for JavaScript inequality operators (#3645)
This release introduces constant folding for the
< > <= >=
operators. The minifier will now replace these operators withtrue
orfalse
when both sides are compile-time numeric or string constants:console.log(1 < 2, '🍕' > '🧀')
// Old output (with --minify)
console.log(1<2,"🍕">"🧀");
// New output (with --minify)
console.log(!0,!1);
Better handling of
__proto__
edge cases (#3651)JavaScript object literal syntax contains a special case where a non-computed property with a key of
__proto__
sets the prototype of the object. This does not apply to computed properties or to properties that use the shorthand property syntax introduced in ES6. Previously esbuild didn't correctly preserve the "sets the prototype" status of properties inside an object literal, meaning a property that sets the prototype could accidentally be transformed into one that doesn't and vice versa. This has now been fixed:function foo(proto) {
return { proto: proto } // Note: sets the prototype
}
function bar(proto, proto) {
{
let proto = proto
return { proto } // Note: doesn't set the prototype
}
}
// Old output
function foo(proto) {
return { proto }; // Note: no longer sets the prototype (WRONG)
}
function bar(proto, proto) {
{
let __proto__2 = proto;
return { proto: __proto__2 }; // Note: now sets the prototype (WRONG)
}
}
// New output
function foo(proto) {
return { proto: proto }; // Note: sets the prototype (correct)
}
function bar(proto, proto) {
{
let __proto__2 = proto;
return { ["proto"]: __proto__2 }; // Note: doesn't set the prototype (correct)
}
}
Fix cross-platform non-determinism with CSS color space transformations (#3650)
The Go compiler takes advantage of "fused multiply and add" (FMA) instructions on certain processors which do the operation
x*y + z
without intermediate rounding. This causes esbuild's CSS color space math to differ on different processors (currentlyppc64le
ands390x
), which breaks esbuild's guarantee of deterministic output. To avoid this, esbuild's color space math now inserts afloat64()
cast around every single math operation. This tells the Go compiler not to use the FMA optimization.Fix a crash when resolving a path from a directory that doesn't exist (#3634)
This release fixes a regression where esbuild could crash when resolving an absolute path if the source directory for the path resolution operation doesn't exist. While this situation doesn't normally come up, it could come up when running esbuild concurrently with another operation that mutates the file system as esbuild is doing a build (such as using
git
to switch branches). The underlying problem was a regression that was introduced in version 0.18.0.This release deliberately contains backwards-incompatible changes. To avoid automatically picking up releases like this, you should either be pinning the exact version of
esbuild
in yourpackage.json
file (recommended) or be using a version range syntax that only accepts patch upgrades such as^0.19.0
or~0.19.0
. See npm's documentation about semver for more information.This time there is only one breaking change, and it only matters for people using Deno. Deno tests that use esbuild will now fail unless you make the change described below.
Work around API deprecations in Deno 1.40.x (#3609, #3611)
Deno 1.40.0 was just released and introduced run-time warnings about certain APIs that esbuild uses. With this release, esbuild will work around these run-time warnings by using newer APIs if they are present and falling back to the original APIs otherwise. This should avoid the warnings without breaking compatibility with older versions of Deno.
Unfortunately, doing this introduces a breaking change. The newer child process APIs lack a way to synchronously terminate esbuild's child process, so calling
esbuild.stop()
from within a Deno test is no longer sufficient to prevent Deno from failing a test that uses esbuild's API (Deno fails tests that create a child process without killing it before the test ends). To work around this, esbuild'sstop()
function has been changed to return a promise, and you now have to changeesbuild.stop()
toawait esbuild.stop()
in all of your Deno tests.Reorder implicit file extensions within
node_modules
(#3341, #3608)In version 0.18.0, esbuild changed the behavior of implicit file extensions within
node_modules
directories (i.e. in published packages) to prefer.js
over.ts
even when the--resolve-extensions=
order prefers.ts
over.js
(which it does by default). However, doing that also accidentally made esbuild prefer.css
over.ts
, which caused problems for people that published packages containing both TypeScript and CSS in files with the same name.With this release, esbuild will reorder TypeScript file extensions immediately after the last JavaScript file extensions in the implicit file extension order instead of putting them at the end of the order. Specifically the default implicit file extension order is
.tsx,.ts,.jsx,.js,.css,.json
which used to become.jsx,.js,.css,.json,.tsx,.ts
innode_modules
directories. With this release it will now become.jsx,.js,.tsx,.ts,.css,.json
instead.Why even rewrite the implicit file extension order at all? One reason is because the
.js
file is more likely to behave correctly than the.ts
file. The behavior of the.ts
file may depend ontsconfig.json
and thetsconfig.json
file may not even be published, or may useextends
to refer to a basetsconfig.json
file that wasn't published. People can get into this situation when they forget to add all.ts
files to their.npmignore
file before publishing to npm. Picking.js
over.ts
helps make it more likely that resulting bundle will behave correctly.The "preserve" JSX mode now preserves JSX text verbatim (#3605)
The JSX specification deliberately doesn't specify how JSX text is supposed to be interpreted and there is no canonical way to interpret JSX text. Two most popular interpretations are Babel and TypeScript. Yes they are different (esbuild deliberately follows TypeScript by the way).
Previously esbuild normalized text to the TypeScript interpretation when the "preserve" JSX mode is active. However, "preserve" should arguably reproduce the original JSX text verbatim so that whatever JSX transform runs after esbuild is free to interpret it however it wants. So with this release, esbuild will now pass JSX text through unmodified:
let el =
<a href={'/'} title=''"'> some text
{foo}
more text </a>
// Old output (with --loader=jsx --jsx=preserve)
let el = <a href="/" title={
'"
}>{" some text"}
{foo}
{"more text "}
</a>;
// New output (with --loader=jsx --jsx=preserve)
let el = <a href={"/"} title=''"'> some text
{foo}
more text </a>;
Allow JSX elements as JSX attribute values
JSX has an obscure feature where you can use JSX elements in attribute position without surrounding them with
{...}
. It looks like this:I think I originally didn't implement it even though it's part of the JSX specification because it previously didn't work in TypeScript (and potentially also in Babel?). However, support for it was silently added in TypeScript 4.8 without me noticing and Babel has also since fixed their bugs regarding this feature. So I'm adding it to esbuild too now that I know it's widely supported.
Keep in mind that there is some ongoing discussion about removing this feature from JSX. I agree that the syntax seems out of place (it does away with the elegance of "JSX is basically just XML with
{...}
escapes" for something arguably harder to read, which doesn't seem like a good trade-off), but it's in the specification and TypeScript and Babel both implement it so I'm going to have esbuild implement it too. However, I reserve the right to remove it from esbuild if it's ever removed from the specification in the future. So use it with caution.Fix a bug with TypeScript type parsing (#3574)
This release fixes a bug with esbuild's TypeScript parser where a conditional type containing a union type that ends with an infer type that ends with a constraint could fail to parse. This was caused by the "don't parse a conditional type" flag not getting passed through the union type parser. Here's an example of valid TypeScript code that previously failed to parse correctly:
Fix TypeScript-specific class transform edge case (#3559)
The previous release introduced an optimization that avoided transforming
super()
in the class constructor for TypeScript code compiled withuseDefineForClassFields
set tofalse
if all class instance fields have no initializers. The rationale was that in this case, all class instance fields are omitted in the output so no changes to the constructor are needed. However, if all of this is the case and there are#private
instance fields with initializers, those private instance field initializers were still being moved into the constructor. This was problematic because they were being inserted before the call tosuper()
(sincesuper()
is now no longer transformed in that case). This release introduces an additional optimization that avoids moving the private instance field initializers into the constructor in this edge case, which generates smaller code, matches the TypeScript compiler's output more closely, and avoids this bug:class Foo extends Bar {
#private = 1;
public: any;
constructor() {
super();
}
}
// Old output (with esbuild v0.19.9)
class Foo extends Bar {
constructor() {
super();
this.#private = 1;
}
#private;
}
// Old output (with esbuild v0.19.10)
class Foo extends Bar {
constructor() {
this.#private = 1;
super();
}
#private;
}
// New output
class Foo extends Bar {
#private = 1;
constructor() {
super();
}
}
Minifier: allow reording a primitive past a side-effect (#3568)
The minifier previously allowed reordering a side-effect past a primitive, but didn't handle the case of reordering a primitive past a side-effect. This additional case is now handled:
function f() {
let x = false;
let y = x;
const boolean = y;
let frag = $.template(
<p contenteditable="<span class="pl-s1"><span class="pl-kos">${</span><span class="pl-s1">boolean</span><span class="pl-kos">}</span></span>">hello world</p>
);return frag;
}
// Old output (with --minify)
function f(){const e=!1;return $.template(
<p contenteditable="<span class="pl-s1"><span class="pl-kos">${</span><span class="pl-s1">e</span><span class="pl-kos">}</span></span>">hello world</p>
)}// New output (with --minify)
function f(){return $.template('<p contenteditable="false">hello world</p>')}
Minifier: consider properties named using known
Symbol
instances to be side-effect free (#3561)Many things in JavaScript can have side effects including property accesses and ToString operations, so using a symbol such as
Symbol.iterator
as a computed property name is not obviously side-effect free. This release adds a special case for knownSymbol
instances so that they are considered side-effect free when used as property names. For example, this class declaration will now be considered side-effect free:Provide the
stop()
API in node to exit esbuild's child process (#3558)You can now call
stop()
in esbuild's node API to exit esbuild's child process to reclaim the resources used. It only makes sense to do this for a long-lived node process when you know you will no longer be making any more esbuild API calls. It is not necessary to call this to allow node to exit, and it's advantageous to not call this in between calls to esbuild's API as sharing a single long-lived esbuild child process is more efficient than re-creating a new esbuild child process for every API call. This API call used to exist but was removed in version 0.9.0. This release adds it back due to a user request.Fix glob imports in TypeScript files (#3319)
This release fixes a problem where bundling a TypeScript file containing a glob import could emit a call to a helper function that doesn't exist. The problem happened because esbuild's TypeScript transformation removes unused imports (which is required for correctness, as they may be type-only imports) and esbuild's glob import transformation wasn't correctly marking the imported helper function as used. This wasn't caught earlier because most of esbuild's glob import tests were written in JavaScript, not in TypeScript.
Fix
require()
glob imports with bundling disabled (#3546)Previously
require()
calls containing glob imports were incorrectly transformed when bundling was disabled. All glob imports should only be transformed when bundling is enabled. This bug has been fixed.Fix a panic when transforming optional chaining with
define
(#3551, #3554)This release fixes a case where esbuild could crash with a panic, which was triggered by using
define
to replace an expression containing an optional chain. Here is an example:console.log(process?.env.SHELL)
// Old output (with --define:process.env={})
/* panic: Internal error (while parsing "<stdin>") */
// New output (with --define:process.env={})
var define_process_env_default = {};
console.log(define_process_env_default.SHELL);
This fix was contributed by @ hi-ogawa.
Work around a bug in node's CommonJS export name detector (#3544)
The export names of a CommonJS module are dynamically-determined at run time because CommonJS exports are properties on a mutable object. But the export names of an ES module are statically-determined at module instantiation time by using
import
andexport
syntax and cannot be changed at run time.When you import a CommonJS module into an ES module in node, node scans over the source code to attempt to detect the set of export names that the CommonJS module will end up using. That statically-determined set of names is used as the set of names that the ES module is allowed to import at module instantiation time. However, this scan appears to have bugs (or at least, can cause false positives) because it doesn't appear to do any scope analysis. Node will incorrectly consider the module to export something even if the assignment is done to a local variable instead of to the module-level
exports
object. For example:You can see that node incorrectly thinks the file
confuseNode.js
has an export callednotAnExport
when that file is loaded in an ES module context:To avoid this, esbuild will now rename local variables that use the names
exports
andmodule
when generating CommonJS output for thenode
platform.Fix the return value of esbuild's
super()
shim (#3538)Some people write
constructor
methods that use the return value ofsuper()
instead of usingthis
. This isn't too common because TypeScript doesn't let you do that but it can come up when writing JavaScript. Previously esbuild's class lowering transform incorrectly transformed the return value ofsuper()
intoundefined
. With this release, the return value ofsuper()
will now bethis
instead:class Foo extends Object {
field
constructor() {
console.log(typeof super())
}
}
new Foo
// Old output (with --target=es6)
class Foo extends Object {
constructor() {
var __super = (...args) => {
super(...args);
__publicField(this, "field");
};
console.log(typeof __super());
}
}
new Foo();
// New output (with --target=es6)
class Foo extends Object {
constructor() {
var __super = (...args) => {
super(...args);
__publicField(this, "field");
return this;
};
console.log(typeof</sp...