ec381b5e4e
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | Pending | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---|---|---|---| | [node](https://nodejs.org) ([source](https://togithub.com/nodejs/node)) | | minor | `20.14.0` -> `20.15.0` | | [![age](https://developer.mend.io/api/mc/badges/age/node-version/node/v20.15.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/node-version/node/v20.15.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/node-version/node/v20.14.0/v20.15.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/node-version/node/v20.14.0/v20.15.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [@types/node](https://togithub.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node) ([source](https://togithub.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node)) | devDependencies | patch | [`20.14.6` -> `20.14.7`](https://renovatebot.com/diffs/npm/@types%2fnode/20.14.6/20.14.7) | `20.14.9` (+1) | [![age](https://developer.mend.io/api/mc/badges/age/npm/@types%2fnode/20.14.7?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/@types%2fnode/20.14.7?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/@types%2fnode/20.14.6/20.14.7?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/@types%2fnode/20.14.6/20.14.7?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>nodejs/node (node)</summary> ### [`v20.15.0`](https://togithub.com/nodejs/node/releases/tag/v20.15.0): 2024-06-20, Version 20.15.0 'Iron' (LTS), @​marco-ippolito [Compare Source](https://togithub.com/nodejs/node/compare/v20.14.0...v20.15.0) ##### test_runner: support test plans It is now possible to count the number of assertions and subtests that are expected to run within a test. If the number of assertions and subtests that run does not match the expected count, the test will fail. ```js test('top level test', (t) => { t.plan(2); t.assert.ok('some relevant assertion here'); t.subtest('subtest', () => {}); }); ``` Contributed by Colin Ihrig in [#​52860](https://togithub.com/nodejs/node/pull/52860) ##### inspector: introduce the `--inspect-wait` flag This release introduces the `--inspect-wait` flag, which allows debugger to wait for attachement. This flag is useful when you want to debug the code from the beginning. Unlike `--inspect-brk`, which breaks on the first line, this flag waits for debugger to be connected and then runs the code as soon as a session is established. Contributed by Kohei Ueno in [#​52734](https://togithub.com/nodejs/node/pull/52734) ##### zlib: expose zlib.crc32() This release exposes the crc32() function from zlib to user-land. It computes a 32-bit Cyclic Redundancy Check checksum of data. If value is specified, it is used as the starting value of the checksum, otherwise, 0 is used as the starting value. The CRC algorithm is designed to compute checksums and to detect error in data transmission. It's not suitable for cryptographic authentication. ```js const zlib = require('node:zlib'); const { Buffer } = require('node:buffer'); let crc = zlib.crc32('hello'); // 907060870 crc = zlib.crc32('world', crc); // 4192936109 crc = zlib.crc32(Buffer.from('hello', 'utf16le')); // 1427272415 crc = zlib.crc32(Buffer.from('world', 'utf16le'), crc); // 4150509955 ``` Contributed by Joyee Cheung in [#​52692](https://togithub.com/nodejs/node/pull/52692) ##### cli: allow running wasm in limited vmem with --disable-wasm-trap-handler By default, Node.js enables trap-handler-based WebAssembly bound checks. As a result, V8 does not need to insert inline bound checks int the code compiled from WebAssembly which may speedup WebAssembly execution significantly, but this optimization requires allocating a big virtual memory cage (currently 10GB). If the Node.js process does not have access to a large enough virtual memory address space due to system configurations or hardware limitations, users won't be able to run any WebAssembly that involves allocation in this virtual memory cage and will see an out-of-memory error. ```console $ ulimit -v 5000000 $ node -p "new WebAssembly.Memory({ initial: 10, maximum: 100 });" [eval]:1 new WebAssembly.Memory({ initial: 10, maximum: 100 }); ^ RangeError: WebAssembly.Memory(): could not allocate memory at [eval]:1:1 at runScriptInThisContext (node:internal/vm:209:10) at node:internal/process/execution:118:14 at [eval]-wrapper:6:24 at runScript (node:internal/process/execution:101:62) at evalScript (node:internal/process/execution:136:3) at node:internal/main/eval_string:49:3 ``` `--disable-wasm-trap-handler` disables this optimization so that users can at least run WebAssembly (with a less optimial performance) when the virtual memory address space available to their Node.js process is lower than what the V8 WebAssembly memory cage needs. Contributed by Joyee Cheung in [#​52766](https://togithub.com/nodejs/node/pull/52766) ##### Other Notable Changes - \[[`12512c3d0e`](https://togithub.com/nodejs/node/commit/12512c3d0e)] - **doc**: add pimterry to collaborators (Tim Perry) [#​52874](https://togithub.com/nodejs/node/pull/52874) - \[[`9d485b40bb`](https://togithub.com/nodejs/node/commit/9d485b40bb)] - **(SEMVER-MINOR)** **tools**: fix get_asan_state() in tools/test.py (Joyee Cheung) [#​52766](https://togithub.com/nodejs/node/pull/52766) - \[[`e98c305f52`](https://togithub.com/nodejs/node/commit/e98c305f52)] - **(SEMVER-MINOR)** **tools**: support max_virtual_memory test configuration (Joyee Cheung) [#​52766](https://togithub.com/nodejs/node/pull/52766) - \[[`dce0300896`](https://togithub.com/nodejs/node/commit/dce0300896)] - **(SEMVER-MINOR)** **tools**: support != in test status files (Joyee Cheung) [#​52766](https://togithub.com/nodejs/node/pull/52766) ##### Commits - \[[`227093bfec`](https://togithub.com/nodejs/node/commit/227093bfec)] - **assert**: add deep equal check for more Error type (Zhenwei Jin) [#​51805](https://togithub.com/nodejs/node/pull/51805) - \[[`184cfe5a71`](https://togithub.com/nodejs/node/commit/184cfe5a71)] - **benchmark**: filter non-present deps from `start-cli-version` (Adam Majer) [#​51746](https://togithub.com/nodejs/node/pull/51746) - \[[`8b3e83bb53`](https://togithub.com/nodejs/node/commit/8b3e83bb53)] - **buffer**: even faster atob (Daniel Lemire) [#​52443](https://togithub.com/nodejs/node/pull/52443) - \[[`8d628c3255`](https://togithub.com/nodejs/node/commit/8d628c3255)] - **buffer**: use size_t instead of uint32\_t to avoid segmentation fault (Xavier Stouder) [#​48033](https://togithub.com/nodejs/node/pull/48033) - \[[`16ae2b2933`](https://togithub.com/nodejs/node/commit/16ae2b2933)] - **buffer**: remove lines setting indexes to integer value (Zhenwei Jin) [#​52588](https://togithub.com/nodejs/node/pull/52588) - \[[`48c15d0dcd`](https://togithub.com/nodejs/node/commit/48c15d0dcd)] - **build**: remove deprecated calls for argument groups (Mohammed Keyvanzadeh) [#​52913](https://togithub.com/nodejs/node/pull/52913) - \[[`1be8232d17`](https://togithub.com/nodejs/node/commit/1be8232d17)] - **build**: drop base64 dep in GN build (Cheng) [#​52856](https://togithub.com/nodejs/node/pull/52856) - \[[`918962d6e7`](https://togithub.com/nodejs/node/commit/918962d6e7)] - **build**: make simdjson a public dep in GN build (Cheng) [#​52755](https://togithub.com/nodejs/node/pull/52755) - \[[`5215b6fd8e`](https://togithub.com/nodejs/node/commit/5215b6fd8e)] - **build, tools**: copy release assets to staging R2 bucket once built (flakey5) [#​51394](https://togithub.com/nodejs/node/pull/51394) - \[[`473fa73857`](https://togithub.com/nodejs/node/commit/473fa73857)] - **(SEMVER-MINOR)** **cli**: allow running wasm in limited vmem with --disable-wasm-trap-handler (Joyee Cheung) [#​52766](https://togithub.com/nodejs/node/pull/52766) - \[[`954d2aded4`](https://togithub.com/nodejs/node/commit/954d2aded4)] - **cluster**: replace `forEach` with `for-of` loop (Jérôme Benoit) [#​50317](https://togithub.com/nodejs/node/pull/50317) - \[[`794e450ea7`](https://togithub.com/nodejs/node/commit/794e450ea7)] - **console**: colorize console error and warn (Jithil P Ponnan) [#​51629](https://togithub.com/nodejs/node/pull/51629) - \[[`0fb7c18f10`](https://togithub.com/nodejs/node/commit/0fb7c18f10)] - **crypto**: fix duplicated switch-case return values (Mustafa Ateş UZUN) [#​49030](https://togithub.com/nodejs/node/pull/49030) - \[[`cd1415c8b2`](https://togithub.com/nodejs/node/commit/cd1415c8b2)] - ***Revert*** "**crypto**: make timingSafeEqual faster for Uint8Array" (Tobias Nießen) [#​53390](https://togithub.com/nodejs/node/pull/53390) - \[[`b774544bb1`](https://togithub.com/nodejs/node/commit/b774544bb1)] - **deps**: enable unbundling of simdjson, simdutf, ada (Daniel Lemire) [#​52924](https://togithub.com/nodejs/node/pull/52924) - \[[`da4dbfc5fd`](https://togithub.com/nodejs/node/commit/da4dbfc5fd)] - **doc**: remove reference to AUTHORS file (Marco Ippolito) [#​52960](https://togithub.com/nodejs/node/pull/52960) - \[[`2f3f2ff8af`](https://togithub.com/nodejs/node/commit/2f3f2ff8af)] - **doc**: update hljs with the latest styles (Aviv Keller) [#​52911](https://togithub.com/nodejs/node/pull/52911) - \[[`3a1d17a9b1`](https://togithub.com/nodejs/node/commit/3a1d17a9b1)] - **doc**: mention quicker way to build docs (Alex Crawford) [#​52937](https://togithub.com/nodejs/node/pull/52937) - \[[`be309bd19d`](https://togithub.com/nodejs/node/commit/be309bd19d)] - **doc**: mention push.followTags config (Rafael Gonzaga) [#​52906](https://togithub.com/nodejs/node/pull/52906) - \[[`e62c6e2684`](https://togithub.com/nodejs/node/commit/e62c6e2684)] - **doc**: document pipeline with `end` option (Alois Klink) [#​48970](https://togithub.com/nodejs/node/pull/48970) - \[[`af27225cf6`](https://togithub.com/nodejs/node/commit/af27225cf6)] - **doc**: add example for `execFileSync` method and ref to stdio (Evan Shortiss) [#​39412](https://togithub.com/nodejs/node/pull/39412) - \[[`086626f9b1`](https://togithub.com/nodejs/node/commit/086626f9b1)] - **doc**: add examples and notes to http server.close et al (mary marchini) [#​49091](https://togithub.com/nodejs/node/pull/49091) - \[[`3aa3337a00`](https://togithub.com/nodejs/node/commit/3aa3337a00)] - **doc**: fix `dns.lookup` family `0` and `all` descriptions (Adam Jones) [#​51653](https://togithub.com/nodejs/node/pull/51653) - \[[`585f2a2e7f`](https://togithub.com/nodejs/node/commit/585f2a2e7f)] - **doc**: update `fs.realpath` documentation (sinkhaha) [#​48170](https://togithub.com/nodejs/node/pull/48170) - \[[`4bf3d44e1d`](https://togithub.com/nodejs/node/commit/4bf3d44e1d)] - **doc**: update fs read documentation for clarity (Mert Can Altin) [#​52453](https://togithub.com/nodejs/node/pull/52453) - \[[`ae5d47dde3`](https://togithub.com/nodejs/node/commit/ae5d47dde3)] - **doc**: watermark string behavior (Benjamin Gruenbaum) [#​52842](https://togithub.com/nodejs/node/pull/52842) - \[[`1e429d10d3`](https://togithub.com/nodejs/node/commit/1e429d10d3)] - **doc**: exclude commits with baking-for-lts (Marco Ippolito) [#​52896](https://togithub.com/nodejs/node/pull/52896) - \[[`3df3e37cdb`](https://togithub.com/nodejs/node/commit/3df3e37cdb)] - **doc**: add names next to release key bash commands (Aviv Keller) [#​52878](https://togithub.com/nodejs/node/pull/52878) - \[[`12512c3d0e`](https://togithub.com/nodejs/node/commit/12512c3d0e)] - **doc**: add pimterry to collaborators (Tim Perry) [#​52874](https://togithub.com/nodejs/node/pull/52874) - \[[`97e0fef019`](https://togithub.com/nodejs/node/commit/97e0fef019)] - **doc**: add more definitions to GLOSSARY.md (Aviv Keller) [#​52798](https://togithub.com/nodejs/node/pull/52798) - \[[`91fadac162`](https://togithub.com/nodejs/node/commit/91fadac162)] - **doc**: make docs more welcoming and descriptive for newcomers (Serkan Özel) [#​38056](https://togithub.com/nodejs/node/pull/38056) - \[[`a3b20126fd`](https://togithub.com/nodejs/node/commit/a3b20126fd)] - **doc**: add OpenSSL errors to API docs (John Lamp) [#​34213](https://togithub.com/nodejs/node/pull/34213) - \[[`9587ae9b5b`](https://togithub.com/nodejs/node/commit/9587ae9b5b)] - **doc**: simplify copy-pasting of `branch-diff` commands (Antoine du Hamel) [#​52757](https://togithub.com/nodejs/node/pull/52757) - \[[`6ea72a53c3`](https://togithub.com/nodejs/node/commit/6ea72a53c3)] - **doc**: add test_runner to subsystem (Raz Luvaton) [#​52774](https://togithub.com/nodejs/node/pull/52774) - \[[`972eafd983`](https://togithub.com/nodejs/node/commit/972eafd983)] - **events**: update MaxListenersExceededWarning message log (sinkhaha) [#​51921](https://togithub.com/nodejs/node/pull/51921) - \[[`74753ed1fe`](https://togithub.com/nodejs/node/commit/74753ed1fe)] - **events**: add stop propagation flag to `Event.stopImmediatePropagation` (Mickael Meausoone) [#​39463](https://togithub.com/nodejs/node/pull/39463) - \[[`75dd009649`](https://togithub.com/nodejs/node/commit/75dd009649)] - **events**: replace NodeCustomEvent with CustomEvent (Feng Yu) [#​43876](https://togithub.com/nodejs/node/pull/43876) - \[[`7d38c2e012`](https://togithub.com/nodejs/node/commit/7d38c2e012)] - **fs**: keep fs.promises.readFile read until EOF is reached (Zhenwei Jin) [#​52178](https://togithub.com/nodejs/node/pull/52178) - \[[`8cb13120d3`](https://togithub.com/nodejs/node/commit/8cb13120d3)] - **(SEMVER-MINOR)** **inspector**: introduce the `--inspect-wait` flag (Kohei Ueno) [#​52734](https://togithub.com/nodejs/node/pull/52734) - \[[`d5ab1de1fd`](https://togithub.com/nodejs/node/commit/d5ab1de1fd)] - **meta**: move `@anonrig` to TSC regular member (Yagiz Nizipli) [#​52932](https://togithub.com/nodejs/node/pull/52932) - \[[`f82d086e90`](https://togithub.com/nodejs/node/commit/f82d086e90)] - **path**: fix toNamespacedPath on Windows (Hüseyin Açacak) [#​52915](https://togithub.com/nodejs/node/pull/52915) - \[[`121ea13b50`](https://togithub.com/nodejs/node/commit/121ea13b50)] - **process**: improve event-loop (Aras Abbasi) [#​52108](https://togithub.com/nodejs/node/pull/52108) - \[[`eceac784aa`](https://togithub.com/nodejs/node/commit/eceac784aa)] - **repl**: fix disruptive autocomplete without inspector (Nitzan Uziely) [#​40661](https://togithub.com/nodejs/node/pull/40661) - \[[`89a910be82`](https://togithub.com/nodejs/node/commit/89a910be82)] - **src**: fix Worker termination in `inspector.waitForDebugger` (Daeyeon Jeong) [#​52527](https://togithub.com/nodejs/node/pull/52527) - \[[`033f985e8a`](https://togithub.com/nodejs/node/commit/033f985e8a)] - **src**: use `S_ISDIR` to check if the file is a directory (theanarkh) [#​52164](https://togithub.com/nodejs/node/pull/52164) - \[[`95128399f8`](https://togithub.com/nodejs/node/commit/95128399f8)] - **src**: allow preventing debug signal handler start (Shelley Vohr) [#​46681](https://togithub.com/nodejs/node/pull/46681) - \[[`b162aeae9e`](https://togithub.com/nodejs/node/commit/b162aeae9e)] - **src**: fix typo Unabled -> Unable (Simon Siefke) [#​52820](https://togithub.com/nodejs/node/pull/52820) - \[[`2dcbf1894a`](https://togithub.com/nodejs/node/commit/2dcbf1894a)] - **src**: avoid unused variable 'error' warning (Michaël Zasso) [#​52886](https://togithub.com/nodejs/node/pull/52886) - \[[`978ee0a635`](https://togithub.com/nodejs/node/commit/978ee0a635)] - **src**: only apply fix in main thread (Paolo Insogna) [#​52702](https://togithub.com/nodejs/node/pull/52702) - \[[`8fc52b38c6`](https://togithub.com/nodejs/node/commit/8fc52b38c6)] - **src**: fix test local edge case (Paolo Insogna) [#​52702](https://togithub.com/nodejs/node/pull/52702) - \[[`d02907ecc4`](https://togithub.com/nodejs/node/commit/d02907ecc4)] - **src**: remove misplaced windows code under posix guard in node.cc (Ali Hassan) [#​52545](https://togithub.com/nodejs/node/pull/52545) - \[[`af29120fa7`](https://togithub.com/nodejs/node/commit/af29120fa7)] - **stream**: use `ByteLengthQueuingStrategy` when not in `objectMode` (Jason) [#​48847](https://togithub.com/nodejs/node/pull/48847) - \[[`a5f3dd137c`](https://togithub.com/nodejs/node/commit/a5f3dd137c)] - **string_decoder**: throw an error when writing a too long buffer (zhenweijin) [#​52215](https://togithub.com/nodejs/node/pull/52215) - \[[`65fa95d57d`](https://togithub.com/nodejs/node/commit/65fa95d57d)] - **test**: add `Debugger.setInstrumentationBreakpoint` known issue (Konstantin Ulitin) [#​31137](https://togithub.com/nodejs/node/pull/31137) - \[[`0513e07805`](https://togithub.com/nodejs/node/commit/0513e07805)] - **test**: use `for-of` instead of `forEach` (Gibby Free) [#​49790](https://togithub.com/nodejs/node/pull/49790) - \[[`1d01325928`](https://togithub.com/nodejs/node/commit/1d01325928)] - **test**: verify request payload is uploaded consistently (Austin Wright) [#​34066](https://togithub.com/nodejs/node/pull/34066) - \[[`7dda156872`](https://togithub.com/nodejs/node/commit/7dda156872)] - **test**: add fuzzer for native/js string conversion (Adam Korczynski) [#​51120](https://togithub.com/nodejs/node/pull/51120) - \[[`5fb829b340`](https://togithub.com/nodejs/node/commit/5fb829b340)] - **test**: add fuzzer for `ClientHelloParser` (AdamKorcz) [#​51088](https://togithub.com/nodejs/node/pull/51088) - \[[`cc74bf789f`](https://togithub.com/nodejs/node/commit/cc74bf789f)] - **test**: fix broken env fuzzer by initializing process (AdamKorcz) [#​51080](https://togithub.com/nodejs/node/pull/51080) - \[[`800b6f65cf`](https://togithub.com/nodejs/node/commit/800b6f65cf)] - **test**: replace `forEach()` in `test-stream-pipe-unpipe-stream` (Dario) [#​50786](https://togithub.com/nodejs/node/pull/50786) - \[[`d08c9a6a31`](https://togithub.com/nodejs/node/commit/d08c9a6a31)] - **test**: test pipeline `end` on transform streams (Alois Klink) [#​48970](https://togithub.com/nodejs/node/pull/48970) - \[[`0be8123ede`](https://togithub.com/nodejs/node/commit/0be8123ede)] - **test**: improve coverage of lib/readline.js (Rongjian Zhang) [#​38646](https://togithub.com/nodejs/node/pull/38646) - \[[`410224415c`](https://togithub.com/nodejs/node/commit/410224415c)] - **test**: updated for each to for of in test file (lyannel) [#​50308](https://togithub.com/nodejs/node/pull/50308) - \[[`556e9a2127`](https://togithub.com/nodejs/node/commit/556e9a2127)] - **test**: move `test-http-server-request-timeouts-mixed` to sequential (Madhuri) [#​45722](https://togithub.com/nodejs/node/pull/45722) - \[[`0638274c07`](https://togithub.com/nodejs/node/commit/0638274c07)] - **test**: fix DNS cancel tests (Szymon Marczak) [#​44432](https://togithub.com/nodejs/node/pull/44432) - \[[`311bdc62bd`](https://togithub.com/nodejs/node/commit/311bdc62bd)] - **test**: add http agent to `executionAsyncResource` (psj-tar-gz) [#​34966](https://togithub.com/nodejs/node/pull/34966) - \[[`6001b164ab`](https://togithub.com/nodejs/node/commit/6001b164ab)] - **test**: reduce memory usage of test-worker-stdio (Adam Majer) [#​37769](https://togithub.com/nodejs/node/pull/37769) - \[[`986bfa26e9`](https://togithub.com/nodejs/node/commit/986bfa26e9)] - **test**: add common.expectRequiredModule() (Joyee Cheung) [#​52868](https://togithub.com/nodejs/node/pull/52868) - \[[`2246d4fd1e`](https://togithub.com/nodejs/node/commit/2246d4fd1e)] - **test**: crypto-rsa-dsa testing for dynamic openssl (Michael Dawson) [#​52781](https://togithub.com/nodejs/node/pull/52781) - \[[`1dce5dea0b`](https://togithub.com/nodejs/node/commit/1dce5dea0b)] - **test**: skip some console tests on dumb terminal (Adam Majer) [#​37770](https://togithub.com/nodejs/node/pull/37770) - \[[`0addeb240c`](https://togithub.com/nodejs/node/commit/0addeb240c)] - **test**: skip v8-updates/test-linux-perf-logger (Michaël Zasso) [#​52821](https://togithub.com/nodejs/node/pull/52821) - \[[`56e19e38f3`](https://togithub.com/nodejs/node/commit/56e19e38f3)] - **test**: drop test-crypto-timing-safe-equal-benchmarks (Rafael Gonzaga) [#​52751](https://togithub.com/nodejs/node/pull/52751) - \[[`0c5e58958c`](https://togithub.com/nodejs/node/commit/0c5e58958c)] - **test, crypto**: use correct object on assert (响马) [#​51820](https://togithub.com/nodejs/node/pull/51820) - \[[`d54aa47ec1`](https://togithub.com/nodejs/node/commit/d54aa47ec1)] - **(SEMVER-MINOR)** **test_runner**: support test plans (Colin Ihrig) [#​52860](https://togithub.com/nodejs/node/pull/52860) - \[[`0289a023a5`](https://togithub.com/nodejs/node/commit/0289a023a5)] - **test_runner**: fix watch mode race condition (Moshe Atlow) [#​52954](https://togithub.com/nodejs/node/pull/52954) - \[[`cf817e192e`](https://togithub.com/nodejs/node/commit/cf817e192e)] - **test_runner**: preserve hook promise when executed twice (Moshe Atlow) [#​52791](https://togithub.com/nodejs/node/pull/52791) - \[[`de541235fe`](https://togithub.com/nodejs/node/commit/de541235fe)] - **tools**: fix v8-update workflow (Michaël Zasso) [#​52957](https://togithub.com/nodejs/node/pull/52957) - \[[`f6290bc327`](https://togithub.com/nodejs/node/commit/f6290bc327)] - **tools**: add --certify-safe to nci-ci (Matteo Collina) [#​52940](https://togithub.com/nodejs/node/pull/52940) - \[[`0830b3115d`](https://togithub.com/nodejs/node/commit/0830b3115d)] - **tools**: fix doc update action (Marco Ippolito) [#​52890](https://togithub.com/nodejs/node/pull/52890) - \[[`9d485b40bb`](https://togithub.com/nodejs/node/commit/9d485b40bb)] - **(SEMVER-MINOR)** **tools**: fix get_asan_state() in tools/test.py (Joyee Cheung) [#​52766](https://togithub.com/nodejs/node/pull/52766) - \[[`e98c305f52`](https://togithub.com/nodejs/node/commit/e98c305f52)] - **(SEMVER-MINOR)** **tools**: support max_virtual_memory test configuration (Joyee Cheung) [#​52766](https://togithub.com/nodejs/node/pull/52766) - \[[`dce0300896`](https://togithub.com/nodejs/node/commit/dce0300896)] - **(SEMVER-MINOR)** **tools**: support != in test status files (Joyee Cheung) [#​52766](https://togithub.com/nodejs/node/pull/52766) - \[[`57006001ec`](https://togithub.com/nodejs/node/commit/57006001ec)] - **tools**: prepare custom rules for ESLint v9 (Michaël Zasso) [#​52889](https://togithub.com/nodejs/node/pull/52889) - \[[`403a4a7557`](https://togithub.com/nodejs/node/commit/403a4a7557)] - **tools**: update lint-md-dependencies to rollup@4.17.2 (Node.js GitHub Bot) [#​52836](https://togithub.com/nodejs/node/pull/52836) - \[[`01eff5860e`](https://togithub.com/nodejs/node/commit/01eff5860e)] - **tools**: update `gr2m/create-or-update-pull-request-action` (Antoine du Hamel) [#​52843](https://togithub.com/nodejs/node/pull/52843) - \[[`514f01ed59`](https://togithub.com/nodejs/node/commit/514f01ed59)] - **tools**: use sccache GitHub action (Michaël Zasso) [#​52839](https://togithub.com/nodejs/node/pull/52839) - \[[`8f8fb91927`](https://togithub.com/nodejs/node/commit/8f8fb91927)] - **tools**: specify a commit-message for V8 update workflow (Antoine du Hamel) [#​52844](https://togithub.com/nodejs/node/pull/52844) - \[[`b83fbf8709`](https://togithub.com/nodejs/node/commit/b83fbf8709)] - **tools**: fix V8 update workflow (Antoine du Hamel) [#​52822](https://togithub.com/nodejs/node/pull/52822) - \[[`be9d6f2176`](https://togithub.com/nodejs/node/commit/be9d6f2176)] - **url,tools,benchmark**: replace deprecated `substr()` (Jungku Lee) [#​51546](https://togithub.com/nodejs/node/pull/51546) - \[[`7603a51d45`](https://togithub.com/nodejs/node/commit/7603a51d45)] - **util**: fix `%s` format behavior with `Symbol.toPrimitive` (Chenyu Yang) [#​50992](https://togithub.com/nodejs/node/pull/50992) - \[[`d7eba50cf3`](https://togithub.com/nodejs/node/commit/d7eba50cf3)] - **util**: improve `isInsideNodeModules` (uzlopak) [#​52147](https://togithub.com/nodejs/node/pull/52147) - \[[`4ae4f7e517`](https://togithub.com/nodejs/node/commit/4ae4f7e517)] - **watch**: allow listening for grouped changes (Matthieu Sieben) [#​52722](https://togithub.com/nodejs/node/pull/52722) - \[[`1ff8f318c0`](https://togithub.com/nodejs/node/commit/1ff8f318c0)] - **watch**: enable passthrough ipc in watch mode (Zack) [#​50890](https://togithub.com/nodejs/node/pull/50890) - \[[`739adf90b1`](https://togithub.com/nodejs/node/commit/739adf90b1)] - **watch**: fix arguments parsing (Moshe Atlow) [#​52760](https://togithub.com/nodejs/node/pull/52760) - \[[`5161d95c30`](https://togithub.com/nodejs/node/commit/5161d95c30)] - **(SEMVER-MINOR)** **zlib**: expose zlib.crc32() (Joyee Cheung) [#​52692](https://togithub.com/nodejs/node/pull/52692) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 7pm every weekday,before 5am every weekday" in timezone Europe/Madrid, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates 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://developer.mend.io/github/Unleash/unleash). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MjAuMSIsInVwZGF0ZWRJblZlciI6IjM3LjQyMC4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> |
||
---|---|---|
.do | ||
.floe | ||
.github | ||
.husky | ||
.vscode | ||
.yarn/releases | ||
coverage | ||
docker | ||
docs/api/oas | ||
examples | ||
frontend | ||
scripts | ||
src | ||
test-migrations | ||
website | ||
.dockerignore | ||
.editorconfig | ||
.gitignore | ||
.lycheeignore | ||
.mergify.yml | ||
.node-version | ||
.npmignore | ||
.nvmrc | ||
.yarnrc.yml | ||
app.json | ||
biome.json | ||
CHANGELOG.md | ||
cliff.toml | ||
CODE_OF_CONDUCT.md | ||
CODEOWNERS | ||
CONTRIBUTING.md | ||
docker-compose.yml | ||
Dockerfile | ||
LICENSE | ||
package.json | ||
README.md | ||
renovate.json | ||
tsconfig.json | ||
USERS.md | ||
yarn.lock |
What is Unleash?
Unleash is a powerful open source solution for feature management. It streamlines your development workflow, accelerates software delivery, and empowers teams to control how and when they roll out new features to end users. With Unleash, you can deploy code to production in smaller, more manageable releases at your own pace.
Feature flags in Unleash let you test your code with real production data, reducing the risk of negatively impacting your users' experience. It also enables your team to work on multiple features simultaneously without the need for separate feature branches.
Unleash is the most popular open source solution for feature flagging on GitHub. It supports 15 official client and server SDKs and over 15 community SDKs. You can even create your own SDK if you wish. Unleash is compatible with any language and framework.
Getting Started with Unleash
1. Setting Up Unleash
To get started with Unleash, you need git
and docker
installed on your machine.
Execute the following commands:
git clone git@github.com:Unleash/unleash.git
cd unleash
docker compose up -d
Then point your browser to localhost:4242
and log in using:
- username:
admin
- password:
unleash4all
If you'd rather run the source code in this repo directly via Node.js, see the step-by-step instructions to get up and running in the contributing guide.
2. Connect your SDK
Find your preferred SDK in our list of official SDKs and import it into your project. Follow the setup guides for your specific SDK.
If you use the docker compose file from the previous step, here's the configuration details you'll need to get going:
- For front-end SDKs, use:
- URL:
http://localhost:4242/api/frontend/
clientKey
:default:development.unleash-insecure-frontend-api-token
- URL:
- For server-side SDKs, use:
- Unleash API URL:
http://localhost:4242/api/
- API token:
default:development.unleash-insecure-api-token
- Unleash API URL:
If you use a different setup, your configuration details will most likely also be different.
Check a feature flag
Checking the state of a feature flag in your code is easy! The syntax will vary depending on your language, but all you need is a simple function call to check whether a flag is available. Here's how it might look in Java:
if (unleash.isEnabled("AwesomeFeature")) {
// do new, flashy thing
} else {
// do old, boring stuff
}
Run Unleash on a service?
If you don't want to run Unleash locally, we also provide easy deployment setups for Heroku and Digital Ocean:
Configure and run Unleash anywhere
The above sections show you how to get up and running quickly and easily. When you're ready to start configuring and customizing Unleash for your own environment, check out the documentation for getting started with self-managed deployments, Unleash configuration options, or running Unleash locally via docker.
Online demo
Try out the Unleash online demo.
Community and help — sharing is caring
We know that learning a new tool can be hard and time-consuming. We have a growing community that loves to help out. Please don't hesitate to reach out for help.
💬 Join Unleash on Slack if you want ask open questions about Unleash, feature toggling or discuss these topics in general.
💻 Create a GitHub issue if you have found a bug or have ideas on how to improve Unleash.
📚 Visit the documentation for more in-depth descriptions, how-to guides, and more.
📖 Learn more about the principles of building and scaling feature flag solutions.
Contribute to Unleash
Unleash is the largest open source feature flag solution on GitHub. Building Unleash is a collaborative effort, and we owe a lot of gratitude to many smart and talented individuals. Building it together with the community ensures that we build a product that solves real problems for real people. We'd love to have your help too: Please feel free to open issues or provide pull requests.
Check out the CONTRIBUTING.md file for contribution guidelines and the Unleash developer guide for tips on environment setup, running the tests, and running Unleash from source.
Contributors
Features our users love
Flexibility and adaptability
- Get an easy overview of all feature flags across all your environments, applications and services
- Use included activation strategies for most common use cases, or use a custom activation strategy to support any need you might have
- Organise feature flags by feature flag tags
- Canary releases / gradual rollouts
- Targeted releases: release features to specific users, IPs, or hostnames
- Kill switches
- A/B testing
- 2 environments
- Out-of-the-box integrations with popular tools (Slack, Microsoft Teams, Datadog) + integrate with anything with webhooks
- Dashboard for managing technical debt and stale flags
- API-first: everything can be automated. No exceptions.
- 12 official client SDKs, and ten community-contributed client SDKs
- Run it via Docker with the official Docker image or as a pure Node.js application
Security and performance
- Privacy by design (GDPR and Schrems II). End-user data never leaves your application.
- Audit logs
- Enforce OWASP's secure headers via the strict HTTPS-only mode
- Flexible hosting options: host it on premise or in the cloud (any cloud)
- Scale the Unleash Proxy independently of the Unleash server to support any number of front-end clients without overloading your Unleash instance
Looking for more features?
If you're looking for one of the following features, please take a look at our Pro and Enterprise plans:
- role-based access control (RBAC)
- single sign-on (SSO)
- more environments
- feature flags project support
- advanced segmentation
- additional strategy constraints
- tighter security
- more hosting options (we can even host it for you!)
Architecture
Read more in the system overview section of the Unleash documentation.
Unleash SDKs
To connect your application to Unleash you'll need to use a client SDK for your programming language.
Official server-side SDKs:
Official front-end SDKs:
The front-end SDKs connects via the Unleash Proxy in order to ensure privacy, scalability and security.
- Android Proxy SDK
- Flutter Proxy SDK
- iOS Proxy SDK
- JavaScript Proxy SDK
- React Proxy SDK
- Svelte Proxy SDK
- Vue Proxy SDK
Community SDKs:
If none of the official SDKs fit your need, there's also a number of community-developed SDKs where you might find an implementation for your preferred language (such as Elixir, Dart, Clojure, and more).
Users of Unleash
Unleash is trusted by thousands of companies all over the world.
Proud Open-Source users: (send us a message if you want to add your logo here)
Migration guides
Unleash has evolved significantly over the past few years, and we know how hard it can be to keep software up to date. If you're using the current major version, upgrading shouldn't be an issue. If you're on a previous major version, check out the Unleash migration guide!
Want to know more about Unleash?
Videos and podcasts
- The Unleash YouTube channel
- Feature toggles — Why and how to add to your software — freeCodeCamp (YouTube)
- Feature flags with Unleash — The Code Kitchen (podcast)
- Feature Flags og Unleash med Fredrik Oseberg — Utviklerpodden (podcast; Norwegian)
Articles and more
- The Unleash Blog
- Designing the Rust Unleash API client — Medium
- FeatureToggle by Martin Fowler
- Feature toggling transient errors in load tests — nrkbeta
- An Interview with Ivar of Unleash — Console
- Unleash your features gradually, slideshow/presentation by Ivar, the creator of Unleash