Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v12.18.1 proposal #33811

Merged
merged 88 commits into from
Jun 17, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
88 commits
Select commit Hold shift + click to select a range
194789f
stream: make all streams error in a pipeline
mcollina Dec 9, 2019
edf75e4
src: use basename(argv0) for --trace-uncaught suggestion
addaleax Apr 12, 2020
1766514
test: add tests for options.fs in fs streams
julianduque May 1, 2020
e572cf9
doc: fix style and grammer in buffer.md
seishun May 1, 2020
c6cf048
doc: explicitly doc package.exports is breaking
MylesBorins Apr 26, 2020
b43fc64
Revert "src: add aliased-buffer-overflow abort test"
richardlau May 1, 2020
c054834
Revert "src: add test/abort build tasks"
richardlau May 1, 2020
ea3a68f
doc: doc and test URLSearchParams discrepancy
jasnell May 4, 2020
033bc96
doc: update napi_async_init documentation
mhdawson Apr 30, 2020
4294d92
stream: make from read one at a time
ronag May 1, 2020
82da74b
n-api: add uint32 test for -1
May 5, 2020
ac5cdd6
doc: add warnings about transferring Buffers and ArrayBuffer
jasnell May 5, 2020
2262962
doc: remove AsyncWrap mentions from async_hooks.md
puzpuzpuz May 5, 2020
ad7a890
doc: add troubleshooting guide for AsyncLocalStorage
puzpuzpuz May 5, 2020
33aacbe
wasi: prevent syscalls before start
tniessen May 4, 2020
4a58420
doc: specify unit of time passed to `fs.utimes`
SimenB May 4, 2020
8b44be9
doc: add Uint8Array to `end` and `write`
rexagod May 2, 2020
9038620
doc: update Buffer(size) documentation
seishun May 1, 2020
0cee4c3
doc: removed unnecessary util imports from vm examples
WalasPrime Apr 30, 2020
59619b0
doc: mention python3-distutils dependency in BUILDING.md
osher Apr 30, 2020
9017bce
lib: fix grammar in internal/bootstrap/loaders.js
szTheory May 2, 2020
139eb6b
test: skip some console tests on dumb terminal
AdamMajer Apr 30, 2020
0177cbf
test: rename test-lookupService-promises
rickyes Apr 27, 2020
0c7cf24
doc: correct description of `decipher.setAuthTag` in crypto.md
jbuhacoff Apr 27, 2020
ed62d43
src: clean up large pages code
May 5, 2020
22f2c2c
wasi: fix poll_oneoff memory interface
cjihrig May 5, 2020
9dde1db
doc: add warning for socket.connect reuse
ronag May 5, 2020
77caf92
module: better error for named exports from cjs
MylesBorins May 5, 2020
a5e8c5c
src: split out callback queue implementation from Environment
addaleax May 6, 2020
6881410
lib: refactored scheduling policy assignment
yashLadha Apr 5, 2020
d64dbfa
meta: add issue template for API reference docs
DerekNonGeneric Apr 20, 2020
642f813
src: fix invalid windowBits=8 gzip segfault
bnoordhuis Apr 24, 2020
631e433
zlib: reject windowBits=8 when mode=GZIP
bnoordhuis Apr 24, 2020
66dbaff
http2: add `bytesWritten` test for `Http2Stream`
rexagod Apr 21, 2020
964adfa
buffer: improve copy() performance
seishun May 2, 2020
4d6f56a
deps: upgrade npm to 6.14.5
ruyadorno May 4, 2020
68551d2
perf_hooks: fix error message for invalid entryTypes
targos May 7, 2020
cd92052
test: add hr-time Web platform tests
targos May 7, 2020
5d5e66c
tools: add eslint rule to only pass through 'test' to debuglog
BridgeAR Mar 9, 2020
cdd7d3a
tools: remove obsolete no-restricted-syntax eslint rules
BridgeAR Mar 9, 2020
b630079
src: remove unnecessary Isolate::GetCurrent() calls
addaleax May 8, 2020
59769c4
lib: fix typo in timers insert function comment
danbev May 8, 2020
2645b1c
tools: update ESLint to 7.0.0
cjihrig May 8, 2020
c459832
test: fix test-net-throttle
Trott May 9, 2020
f27ae6e
src: fix typo in comment in async_wrap.cc
danbev May 11, 2020
30c9cb5
doc: fix typo in n-api.md
danbev May 9, 2020
318fcf8
doc: add note about clientError writable handling
ShogunPanda May 8, 2020
548672d
src: use MaybeLocal.ToLocal instead of IsEmpty
danbev May 8, 2020
82c43d1
src: delete unused variables to resolve compile time print warning
rickyes May 11, 2020
fe780a5
src: remove unused using declarations in node.cc
danbev May 6, 2020
1f159e4
src: add primordials to arguments comment
danbev May 9, 2020
fa16313
test: update WPT interfaces and hr-time
joyeecheung May 12, 2020
33a7878
test: refactor WPTRunner
joyeecheung May 6, 2020
7315c22
tls: fix --tls-keylog option
mildsunrise May 12, 2020
3d8ba29
doc: add examples for implementing ESM
rosaxxny Apr 30, 2020
9f594be
test: fix test-dns-idna2008
Trott May 12, 2020
d2897a2
doc: enhance guides by fixing and making grammar more consistent
ChrisAHolland Apr 29, 2020
aa4611c
fs: clean up Dir.read() uv_fs_t data before calling into JS
addaleax May 6, 2020
c129e88
fs: forbid concurrent operations on Dir handle
addaleax May 7, 2020
8a92698
worker: call CancelTerminateExecution() before exiting Locker
addaleax May 10, 2020
ba93c8d
async_hooks: clear async_id_stack for terminations in more places
addaleax May 11, 2020
5da7d52
test: regression tests for async_hooks + Promise + Worker interaction
addaleax May 10, 2020
a0bc2e3
src: replace to CHECK_NOT_NULL in node_crypto
himself65 May 13, 2020
4f6e4ae
module: add specific error for dir import
aduh95 May 3, 2020
a029dca
esm: improve commonjs hint on module not found
aduh95 May 14, 2020
29d24db
src: add #include <string> in json_utils.h
zcbenz May 10, 2020
b4d9034
worker: fix crash when .unref() is called during exit
addaleax May 14, 2020
b924910
src: distinguish refed/unrefed threadsafe Immediates
addaleax May 9, 2020
a9ed287
doc: fix extension in esm example
devsnek May 14, 2020
e240d56
tools: update dependencies for markdown linting
Trott May 15, 2020
5d80576
errors: skip fatal error highlighting on windows
Hakerh400 Apr 28, 2020
9883ba6
src: add promise_resolve to SetupHooks comment
danbev May 12, 2020
e668376
src: remove unused misc variable
danbev May 15, 2020
548db2e
src: remove unused IsolateSettings variable
danbev May 15, 2020
a48aeb3
doc: clarify about the Node.js-only extensions in perf_hooks
joyeecheung May 1, 2020
402aa1b
deps: upgrade to libuv 1.38.0
cjihrig May 17, 2020
4749156
doc: add comment about highWaterMark limit
benjamingr May 16, 2020
0c9b826
doc: update function description for `decipher.setAAD`
jbuhacoff Apr 27, 2020
c797c7c
src: reduce duplication in RegisterHandleCleanups
danbev May 15, 2020
5eed20b
worker: fix race condition in node_messaging.cc
addaleax May 16, 2020
fa4a37c
http2: comment on usage of `Object.create(null)`
rexagod Apr 25, 2020
7d8a226
doc: fix typos in handle scope descriptions
tniessen May 6, 2020
9572701
doc: add fs.open() multiple constants example
Ethan-Arrowood May 7, 2020
98a7026
doc: document module.path
aduh95 May 9, 2020
e67df04
src: use BaseObjectPtr in StreamReq::Dispose
jasnell Apr 27, 2020
5c7176b
deps: update to uvwasi 0.0.9
cjihrig May 4, 2020
af95bd7
deps: V8: cherry-pick 548f6c81d424
dominykas May 20, 2020
6665f73
2020-06-17, Version 12.18.1 'Erbium' (LTS)
codebytere Jun 9, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc: enhance guides by fixing and making grammar more consistent
PR-URL: #33152
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
  • Loading branch information
ChrisAHolland authored and codebytere committed Jun 9, 2020
commit d2897a28367cf77e33108bc068e91ff9ba0ac7fd
58 changes: 30 additions & 28 deletions doc/guides/collaborator-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,8 @@ review by @-mention.
See [Who to CC in the issue tracker](#who-to-cc-in-the-issue-tracker).

If you are the first Collaborator to approve a pull request that has no CI yet,
please [start one](#testing-and-ci). Please also start a new CI if the PR
creator pushed new code since the last CI run.
please [start one](#testing-and-ci). Please also start a new CI if the
pull request creator pushed new code since the last CI run.

### Consensus Seeking

Expand Down Expand Up @@ -269,22 +269,22 @@ master branch.

Examples of breaking changes include:

* removal or redefinition of existing API arguments
* changing return values
* removing or modifying existing properties on an options argument
* adding or removing errors
* altering expected timing of an event
* changing the side effects of using a particular API
* Removal or redefinition of existing API arguments.
* Changing return values.
* Removing or modifying existing properties on an options argument.
* Adding or removing errors.
* Altering expected timing of an event.
* Changing the side effects of using a particular API.

#### Breaking Changes and Deprecations

Existing stable public APIs that change in a backward-incompatible way must
undergo deprecation. The exceptions to this rule are:

* Adding or removing errors thrown or reported by a public API;
* Changing error messages for errors without error code;
* Altering the timing and non-internal side effects of the public API;
* Changes to errors thrown by dependencies of Node.js, such as V8;
* Adding or removing errors thrown or reported by a public API.
* Changing error messages for errors without error code.
* Altering the timing and non-internal side effects of the public API.
* Changes to errors thrown by dependencies of Node.js, such as V8.
* One-time exceptions granted by the TSC.

For more information, see [Deprecations](#deprecations).
Expand All @@ -310,7 +310,7 @@ after-the-fact.
Revert commits with `git revert <HASH>` or `git revert <FROM>..<TO>`. The
generated commit message will not have a subsystem and may violate line length
rules. That is OK. Append the reason for the revert and any `Refs` or `Fixes`
metadata. Raise a Pull Request like any other change.
metadata. Raise a pull request like any other change.

### Introducing New Modules

Expand Down Expand Up @@ -400,10 +400,10 @@ deprecation level of an API.
Collaborators may opt to elevate pull requests or issues to the [TSC][].
Do this if a pull request or issue:

* is labeled `semver-major`, or
* has a significant impact on the codebase, or
* is controversial, or
* is at an impasse among Collaborators who are participating in the discussion.
* Is labeled `semver-major`, or
* Has a significant impact on the codebase, or
* Is controversial, or
* Is at an impasse among Collaborators who are participating in the discussion.

@-mention the `@nodejs/tsc` GitHub team if you want to elevate an issue to the
[TSC][]. Do not use the GitHub UI on the right-hand side to assign to
Expand Down Expand Up @@ -573,7 +573,7 @@ for that commit. This is an opportunity to fix commit messages.
* The commit message text must conform to the [commit message guidelines][].
* <a name="metadata"></a>Change the original commit message to include metadata. (The
[`git node metadata`][git-node-metadata] command can generate the metadata
for you.)
for you).

* Required: A `PR-URL:` line that references the full GitHub URL of the pull
request. This makes it easy to trace a commit back to the conversation that
Expand All @@ -584,7 +584,8 @@ for that commit. This is an opportunity to fix commit messages.
background.
* Required: A `Reviewed-By: Name <email>` line for each Collaborator who
reviewed the change.
* Useful for @mentions / contact list if something goes wrong in the PR.
* Useful for @mentions / contact list if something goes wrong in the
pull request.
* Protects against the assumption that GitHub will be around forever.

Other changes may have landed on master since the successful CI run. As a
Expand All @@ -599,12 +600,13 @@ $ git rev-list upstream/master...HEAD | xargs core-validate-commit

Optional: For your own commits, force push the amended commit to the pull
request branch. If your branch name is `bugfix`, then: `git push
--force-with-lease origin master:bugfix`. Don't close the PR. It will close
after you push it upstream. It will have the purple merged status rather than
the red closed status. If you close the PR before GitHub adjusts its status, it
will show up as a 0 commit PR with no changed files. The order of operations is
important. If you push upstream before you push to your branch, GitHub will
close the issue with the red closed status.
--force-with-lease origin master:bugfix`. Don't close the pull request.
It will close after you push it upstream. It will have the purple merged
status rather than the red closed status. If you close the pull request
before GitHub adjusts its status, it will show up as a 0 commit pull
request with no changed files. The order of operations is important.
If you push upstream before you push to your branch, GitHub will close
the issue with the red closed status.

Time to push it:

Expand Down Expand Up @@ -645,7 +647,7 @@ git push upstream master
### I Made a Mistake

* Ping a TSC member.
* `#node-dev` on freenode
* `#node-dev` on freenode.
* With `git`, there's a way to override remote trees by force pushing
(`git push -f`). This is generally forbidden as it creates conflicts in other
people's forks. It is permissible for simpler slip-ups such as typos in commit
Expand Down Expand Up @@ -701,8 +703,8 @@ land on the staging branches, the backporter removes the `lts-watch-` label.
Likewise, as commits land in an LTS release, the releaser removes the `land-on-`
label.

Attach the appropriate `lts-watch-` label to any PR that may impact an LTS
release.
Attach the appropriate `lts-watch-` label to any pull request that
may impact an LTS release.

## Who to CC in the issue tracker

Expand Down
28 changes: 14 additions & 14 deletions doc/guides/cpp-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,13 @@ runtime features.

Coding guidelines are based on the following guides (highest priority first):

1. This document
2. The [Google C++ Style Guide][]
3. The ISO [C++ Core Guidelines][]
1. This document.
2. The [Google C++ Style Guide][].
3. The ISO [C++ Core Guidelines][].

In general code should follow the C++ Core Guidelines, unless overridden by the
In general, code should follow the C++ Core Guidelines, unless overridden by the
Google C++ Style Guide or this document. At the moment these guidelines are
checked manually by reviewers, with the goal to validate this with automatic
checked manually by reviewers with the goal to validate this with automatic
tools.

## Formatting
Expand Down Expand Up @@ -282,11 +282,11 @@ data[0] = 12345;

### Type casting

* Use `static_cast<T>` if casting is required, and it is valid
* Use `reinterpret_cast` only when it is necessary
* Avoid C-style casts (`(type)value`)
* Use `static_cast<T>` if casting is required, and it is valid.
* Use `reinterpret_cast` only when it is necessary.
* Avoid C-style casts (`(type)value`).
* `dynamic_cast` does not work because Node.js is built without
[Run Time Type Information][]
[Run Time Type Information][].

Further reading:

Expand All @@ -313,13 +313,13 @@ for (const auto& item : some_map) {

### Do not include `*.h` if `*-inl.h` has already been included

Do
Do:

```cpp
#include "util-inl.h" // already includes util.h
```

instead of
Instead of:

```cpp
#include "util.h"
Expand Down Expand Up @@ -383,9 +383,9 @@ exports.foo = function(str) {
#### Avoid throwing JavaScript errors in nested C++ methods

When you need to throw a JavaScript exception from C++ (i.e.
`isolate()->ThrowException()`) prefer to do it as close to the return to JS as
possible, and not inside of nested C++ calls. Since this changes the JS
execution state doing it closest to where it is consumed reduces the chances of
`isolate()->ThrowException()`), do it as close to the return to JavaScript as
possible, and not inside of nested C++ calls. Since this changes the JavaScript
execution state, doing it closest to where it is consumed reduces the chances of
side effects.

Node.js is built [without C++ exception handling][], so code using `throw` or
Expand Down
4 changes: 2 additions & 2 deletions doc/guides/cve-management-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ than two remaining CVEs a new block must be requested as follows:
to the Available list.

All changes to the files for managing CVEs in a given year will
be done through Pull Requests so that we have a record of how
be done through pull requests so that we have a record of how
the CVEs have been assigned.

CVEs are only valid for a specific year. At the beginning of each
Expand Down Expand Up @@ -122,7 +122,7 @@ following steps are used to assign, announce and report a CVE.
verification of the identity of the CVE submitter.

For each CVE listed, the additional data must include the following fields
updated with appropriate data for the CVE
updated with appropriate data for the CVE:
```text
[CVEID]: CVE-XXXX-XXXX
[PRODUCT]: Node.js
Expand Down
24 changes: 13 additions & 11 deletions doc/guides/maintaining-openssl.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
This document describes how to update `deps/openssl/`.

## Requirements
* Linux environment
* Linux environment.
* `perl` Only Perl version 5 is tested.
* `nasm` (<http://www.nasm.us/>) The version of 2.11 or higher is needed.
* GNU `as` in binutils. The version of 2.26 or higher is needed.
* `nasm` (<http://www.nasm.us/>) Version 2.11 or higher is needed.
* GNU `as` in binutils. Version 2.26 or higher is needed.

## 0. Check Requirements

Expand Down Expand Up @@ -39,7 +39,8 @@ them.
% git commit openssl
````

The commit message can be (with the openssl version set to the relevant value):
The commit message can be written as (with the openssl version set
to the relevant value):
```text
deps: upgrade openssl sources to 1.1.0h

Expand All @@ -62,15 +63,15 @@ Use `make` to regenerate all platform dependent files in

## 3. Check diffs

Check diffs if updates are right. Even if no updates in openssl
sources, `buildinf.h` files will be updated for they have a timestamp
Check diffs to ensure updates are right. Even if there are no updates in openssl
sources, `buildinf.h` files will be updated because they have timestamp
data in them.
```sh
% git diff -- deps/openssl
```

*Note*: On Windows, OpenSSL Configure generates `makefile` that can be
used for `nmake` command. The `make` command in the step 2 above uses
*Note*: On Windows, OpenSSL Configure generates a `makefile` that can be
used for the `nmake` command. The `make` command in step 2 (above) uses
`Makefile_VC-WIN64A` and `Makefile_VC-WIN32` that are manually
created. When source files or build options are updated in Windows,
it needs to change these two Makefiles by hand. If you are not sure,
Expand All @@ -79,7 +80,7 @@ please ask @shigeki for details.
## 4. Commit and make test

Update all architecture dependent files. Do not forget to git add or remove
files if they are changed before commit:
files if they are changed before committing:
```sh
% git add deps/openssl/config/archs
% git add deps/openssl/openssl/include/crypto/bn_conf.h
Expand All @@ -88,7 +89,8 @@ files if they are changed before commit:
% git commit
```

The commit message can be (with the openssl version set to the relevant value):
The commit message can be written as (with the openssl version set
to the relevant value):
```text
deps: update archs files for OpenSSL-1.1.0

Expand All @@ -102,4 +104,4 @@ The commit message can be (with the openssl version set to the relevant value):
$ git commit
```

Finally, build Node.js and run tests.
Finally, build Node.js and run the tests.