Skip to content

Commit

Permalink
chore(deps): update dependency esbuild to ^0.16.0 (#350)
Browse files Browse the repository at this point in the history
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [esbuild](https://togithub.com/evanw/esbuild) | [`^0.15.1` ->
`^0.16.0`](https://renovatebot.com/diffs/npm/esbuild/0.15.18/0.16.1) |
[![age](https://badges.renovateapi.com/packages/npm/esbuild/0.16.1/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/esbuild/0.16.1/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/esbuild/0.16.1/compatibility-slim/0.15.18)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/esbuild/0.16.1/confidence-slim/0.15.18)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>evanw/esbuild</summary>

###
[`v0.16.1`](https://togithub.com/evanw/esbuild/blob/HEAD/CHANGELOG.md#&#8203;0161)

[Compare
Source](https://togithub.com/evanw/esbuild/compare/v0.16.0...v0.16.1)

This is a hotfix for the previous release.

- Re-allow importing JSON with the `copy` loader using an import
assertion

The previous release made it so when `assert { type: 'json' }` is
present on an import statement, esbuild validated that the `json` loader
was used. This is what an import assertion is supposed to do. However, I
forgot about the relatively new `copy` loader, which sort of behaves as
if the import path was marked as external (and thus not loaded at all)
except that the file is copied to the output directory and the import
path is rewritten to point to the copy. In this case whatever JavaScript
runtime ends up running the code is the one to evaluate the import
assertion. So esbuild should really allow this case as well. With this
release, esbuild now allows both the `json` and `copy` loaders when an
`assert { type: 'json' }` import assertion is present.

###
[`v0.16.0`](https://togithub.com/evanw/esbuild/blob/HEAD/CHANGELOG.md#&#8203;0160)

[Compare
Source](https://togithub.com/evanw/esbuild/compare/v0.15.18...v0.16.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 your `package.json` file
(recommended) or be using a version range syntax that only accepts patch
upgrades such as `~0.15.0`. See npm's documentation about
[semver](https://docs.npmjs.com/cli/v6/using-npm/semver/) for more
information.

-   Move all binary executable packages to the `@esbuild/` scope

Binary package executables for esbuild are published as individual
packages separate from the main `esbuild` package so you only have to
download the relevant one for the current platform when you install
esbuild. This release moves all of these packages under the `@esbuild/`
scope to avoid collisions with 3rd-party packages. It also changes them
to a consistent naming scheme that uses the `os` and `cpu` names from
node.

    The package name changes are as follows:

    -   `@esbuild/linux-loong64` => `@esbuild/linux-loong64` (no change)
    -   `esbuild-android-64` => `@esbuild/android-x64`
    -   `esbuild-android-arm64` => `@esbuild/android-arm64`
    -   `esbuild-darwin-64` => `@esbuild/darwin-x64`
    -   `esbuild-darwin-arm64` => `@esbuild/darwin-arm64`
    -   `esbuild-freebsd-64` => `@esbuild/freebsd-x64`
    -   `esbuild-freebsd-arm64` => `@esbuild/freebsd-arm64`
    -   `esbuild-linux-32` => `@esbuild/linux-ia32`
    -   `esbuild-linux-64` => `@esbuild/linux-x64`
    -   `esbuild-linux-arm` => `@esbuild/linux-arm`
    -   `esbuild-linux-arm64` => `@esbuild/linux-arm64`
    -   `esbuild-linux-mips64le` => `@esbuild/linux-mips64el`
    -   `esbuild-linux-ppc64le` => `@esbuild/linux-ppc64`
    -   `esbuild-linux-riscv64` => `@esbuild/linux-riscv64`
    -   `esbuild-linux-s390x` => `@esbuild/linux-s390x`
    -   `esbuild-netbsd-64` => `@esbuild/netbsd-x64`
    -   `esbuild-openbsd-64` => `@esbuild/openbsd-x64`
    -   `esbuild-sunos-64` => `@esbuild/sunos-x64`
    -   `esbuild-wasm` => `esbuild-wasm` (no change)
    -   `esbuild-windows-32` => `@esbuild/win32-ia32`
    -   `esbuild-windows-64` => `@esbuild/win32-x64`
    -   `esbuild-windows-arm64` => `@esbuild/win32-arm64`
    -   `esbuild` => `esbuild` (no change)

Normal usage of the `esbuild` and `esbuild-wasm` packages should not be
affected. These name changes should only affect tools that hard-coded
the individual binary executable package names into custom esbuild
downloader scripts.

This change was not made with performance in mind. But as a bonus,
installing esbuild with npm may potentially happen faster now. This is
because npm's package installation protocol is inefficient: it always
downloads metadata for all past versions of each package even when it
only needs metadata about a single version. This makes npm package
downloads O(n) in the number of published versions, which penalizes
packages like esbuild that are updated regularly. Since most of
esbuild's package names have now changed, npm will now need to download
much less data when installing esbuild (8.72mb of package manifests
before this change → 0.06mb of package manifests after this change).
However, this is only a temporary improvement. Installing esbuild will
gradually get slower again as further versions of esbuild are published.

-   Publish a shell script that downloads esbuild directly

In addition to all of the existing ways to install esbuild, you can now
also download esbuild directly like this:

    ```sh
    curl -fsSL https://esbuild.github.io/dl/latest | sh
    ```

This runs a small shell script that downloads the latest `esbuild`
binary executable to the current directory. This can be convenient on
systems that don't have `npm` installed or when you just want to get a
copy of esbuild quickly without any extra steps. If you want a specific
version of esbuild (starting with this version onward), you can provide
that version in the URL instead of `latest`:

    ```sh
    curl -fsSL https://esbuild.github.io/dl/v0.16.0 | sh
    ```

Note that the download script needs to be able to access
registry.npmjs.org to be able to complete the download. This download
script doesn't yet support all of the platforms that esbuild supports
because I lack the necessary testing environments. If the download
script doesn't work for you because you're on an unsupported platform,
please file an issue on the esbuild repo so we can add support for it.

-   Fix some parameter names for the Go API

This release changes some parameter names for the Go API to be
consistent with the JavaScript and CLI APIs:

    -   `OutExtensions` => `OutExtension`
    -   `JSXMode` => `JSX`

-   Add additional validation of API parameters

The JavaScript API now does some additional validation of API parameters
to catch incorrect uses of esbuild's API. The biggest impact of this is
likely that esbuild now strictly only accepts strings with the `define`
parameter. This would already have been a type error with esbuild's
TypeScript type definitions, but it was previously not enforced for
people using esbuild's API JavaScript without TypeScript.

The `define` parameter appears at first glance to take a JSON object if
you aren't paying close attention, but this actually isn't true. Values
for `define` are instead strings of JavaScript code. This means you have
to use `define: { foo: '"bar"' }` to replace `foo` with the string
`"bar"`. Using `define: { foo: 'bar' }` actually replaces `foo` with the
identifier `bar`. Previously esbuild allowed you to pass `define: { foo:
false }` and `false` was automatically converted into a string, which
made it more confusing to understand what `define` actually represents.
Starting with this release, passing non-string values such as with
`define: { foo: false }` will no longer be allowed. You will now have to
write `define: { foo: 'false' }` instead.

- Generate shorter data URLs if possible
([#&#8203;1843](https://togithub.com/evanw/esbuild/issues/1843))

Loading a file with esbuild's `dataurl` loader generates a JavaScript
module with a [data
URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs)
for that file in a string as a single default export. Previously the
data URLs generated by esbuild all used [base64
encoding](https://en.wikipedia.org/wiki/Base64). However, this is
unnecessarily long for most textual data (e.g. SVG images). So with this
release, esbuild's `dataurl` loader will now use percent encoding
instead of base64 encoding if the result will be shorter. This can
result in ~25% smaller data URLs for large SVGs. If you want the old
behavior, you can use the `base64` loader instead and then construct the
data URL yourself.

- Avoid marking entry points as external
([#&#8203;2382](https://togithub.com/evanw/esbuild/issues/2382))

Previously you couldn't specify `--external:*` to mark all import paths
as external because that also ended up making the entry point itself
external, which caused the build to fail. With this release, esbuild's
`external` API parameter no longer applies to entry points so using
`--external:*` is now possible.

One additional consequence of this change is that the `kind` parameter
is now required when calling the `resolve()` function in esbuild's
plugin API. Previously the `kind` parameter defaulted to `entry-point`,
but that no longer interacts with `external` so it didn't seem wise for
this to continue to be the default. You now have to specify `kind` so
that the path resolution mode is explicit.

- Disallow non-`default` imports when `assert { type: 'json' }` is
present

There is now standard behavior for importing a JSON file into an ES
module using an `import` statement. However, it requires you to place
the `assert { type: 'json' }` import assertion after the import path.
This import assertion tells the JavaScript runtime to throw an error if
the import does not end up resolving to a JSON file. On the web, the
type of a file is determined by the `Content-Type` HTTP header instead
of by the file extension. The import assertion prevents security
problems on the web where a `.json` file may actually resolve to a
JavaScript file containing malicious code, which is likely not expected
for an import that is supposed to only contain pure side-effect free
data.

By default, esbuild uses the file extension to determine the type of a
file, so this import assertion is unnecessary with esbuild. However,
esbuild's JSON import feature has a non-standard extension that allows
you to import top-level properties of the JSON object as named imports.
For example, esbuild lets you do this:

    ```js
    import { version } from './package.json'
    ```

This is useful for tree-shaking when bundling because it means esbuild
will only include the the `version` field of `package.json` in your
bundle. This is non-standard behavior though and doesn't match the
behavior of what happens when you import JSON in a real JavaScript
runtime (after adding `assert { type: 'json' }`). In a real JavaScript
runtime the only thing you can import is the `default` import. So with
this release, esbuild will now prevent you from importing non-`default`
import names if `assert { type: 'json' }` is present. This ensures that
code containing `assert { type: 'json' }` isn't relying on non-standard
behavior that won't work everywhere. So the following code is now an
error with esbuild when bundling:

    ```js
    import { version } from './package.json' assert { type: 'json' }
    ```

In addition, adding `assert { type: 'json' }` to an import statement now
means esbuild will generate an error if the loader for the file is
anything other than `json`, which is required by the import assertion
specification.

- Provide a way to disable automatic escaping of `</script>`
([#&#8203;2649](https://togithub.com/evanw/esbuild/issues/2649))

If you inject esbuild's output into a script tag in an HTML file, code
containing the literal characters `</script>` will cause the tag to be
ended early which will break the code:

    ```html
    <script>
      console.log("</script>");
    </script>
    ```

To avoid this, esbuild automatically escapes these strings in generated
JavaScript files (e.g. `"</script>"` becomes `"<\/script>"` instead).
This also applies to `</style>` in generated CSS files. Previously this
always happened and there wasn't a way to turn this off.

With this release, esbuild will now only do this if the `platform`
setting is set to `browser` (the default value). Setting `platform` to
`node` or `neutral` will disable this behavior. This behavior can also
now be disabled with `--supported:inline-script=false` (for JS) and
`--supported:inline-style=false` (for CSS).

- Throw an early error if decoded UTF-8 text isn't a `Uint8Array`
([#&#8203;2532](https://togithub.com/evanw/esbuild/issues/2532))

If you run esbuild's JavaScript API in a broken JavaScript environment
where `new TextEncoder().encode("") instanceof Uint8Array` is false,
then esbuild's API will fail with a confusing serialization error
message that makes it seem like esbuild has a bug even though the real
problem is that the JavaScript environment itself is broken. This can
happen when using the test framework called [Jest](https://jestjs.io/).
With this release, esbuild's API will now throw earlier when it detects
that the environment is unable to encode UTF-8 text correctly with an
error message that makes it more clear that this is not a problem with
esbuild.

-   Change the default "legal comment" behavior

The legal comments feature automatically gathers comments containing
`@license` or `@preserve` and puts the comments somewhere (either in the
generated code or in a separate file). People sometimes want this to
happen so that the their dependencies' software licenses are retained in
the generated output code. By default esbuild puts these comments at the
end of the file when bundling. However, people sometimes find this
confusing because these comments can be very generic and may not mention
which library they come from. So with this release, esbuild will now
discard legal comments by default. You now have to opt-in to preserving
them if you want this behavior.

- Enable the `module` condition by default
([#&#8203;2417](https://togithub.com/evanw/esbuild/issues/2417))

Package authors want to be able to use the new
[`exports`](https://nodejs.org/api/packages.html#conditional-exports)
field in `package.json` to provide tree-shakable ESM code for ESM-aware
bundlers while simultaneously providing fallback CommonJS code for other
cases.

Node's proposed way to do this involves using the `import` and `require`
export conditions so that you get the ESM code if you use an import
statement and the CommonJS code if you use a require call. However, this
has a major drawback: if some code in the bundle uses an import
statement and other code in the bundle uses a require call, then you'll
get two copies of the same package in the bundle. This is known as the
[dual package
hazard](https://nodejs.org/api/packages.html#dual-package-hazard) and
can lead to bloated bundles or even worse to subtle logic bugs.

Webpack supports an alternate solution: an export condition called
`module` that takes effect regardless of whether the package was
imported using an import statement or a require call. This works because
bundlers such as Webpack support importing a ESM using a require call
(something node doesn't support). You could already do this with esbuild
using `--conditions=module` but you previously had to explicitly enable
this. Package authors are concerned that esbuild users won't know to do
this and will get suboptimal output with their package, so they have
requested for esbuild to do this automatically.

So with this release, esbuild will now automatically add the `module`
condition when there aren't any custom `conditions` already configured.
You can disable this with `--conditions=` or `conditions: []` (i.e.
explicitly clearing all custom conditions).

-   Rename the `master` branch to `main`

The primary branch for this repository was previously called `master`
but is now called `main`. This change mirrors a similar change in many
other projects.

- Remove esbuild's `_exit(0)` hack for WebAssembly
([#&#8203;714](https://togithub.com/evanw/esbuild/issues/714))

Node had an unfortunate bug where the node process is unnecessarily kept
open while a WebAssembly module is being optimized:
[https://github.com/nodejs/node/issues/36616](https://togithub.com/nodejs/node/issues/36616).
This means cases where running `esbuild` should take a few milliseconds
can end up taking many seconds instead.

The workaround was to force node to exit by ending the process early.
This was done by esbuild in one of two ways depending on the exit code.
For non-zero exit codes (i.e. when there is a build error), the
`esbuild` command could just call `process.kill(process.pid)` to avoid
the hang. But for zero exit codes, esbuild had to load a N-API native
node extension that calls the operating system's `exit(0)` function.

However, this problem has essentially been fixed in node starting with
version 18.3.0. So I have removed this hack from esbuild. If you are
using an earlier version of node with `esbuild-wasm` and you don't want
the `esbuild` command to hang for a while when exiting, you can upgrade
to node 18.3.0 or higher to remove the hang.

The fix came from a V8 upgrade: [this
commit](https://togithub.com/v8/v8/commit/bfe12807c14c91714c7db1485e6b265439375e16)
enabled [dynamic tiering for
WebAssembly](https://v8.dev/blog/wasm-dynamic-tiering) by default for
all projects that use V8's WebAssembly implementation. Previously all
functions in the WebAssembly module were optimized in a single batch job
but with dynamic tiering, V8 now optimizes individual WebAssembly
functions as needed. This avoids unnecessary WebAssembly compilation
which allows node to exit on time.

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://app.renovatebot.com/dashboard#github/open-feature/js-sdk).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC40OS4wIiwidXBkYXRlZEluVmVyIjoiMzQuNDkuMCJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
  • Loading branch information
renovate[bot] authored Dec 7, 2022
1 parent 5d87551 commit 4d4fca4
Show file tree
Hide file tree
Showing 2 changed files with 599 additions and 599 deletions.
Loading

0 comments on commit 4d4fca4

Please sign in to comment.