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.

Sign up for GitHub

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

Jump to bottom

src: prefer param function check over args length #23835

Closed
wants to merge 1 commit into from
Closed

src: prefer param function check over args length #23835

wants to merge 1 commit into from

Conversation

codebytere
Copy link
Member

@codebytere codebytere commented Oct 23, 2018 •
edited
Loading

We have to override some fs methods in Electron, and as I looked at their original impls I believe that checking the type of the second argument as opposed to simply the number of arguments passed is more consistent and reliable.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • commit message follows commit guidelines

@nodejs-github-bot
Copy link
Collaborator

@codebytere build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/1346/pipeline

@nodejs-github-bot nodejs-github-bot added the fs Issues and PRs related to the fs subsystem / file system. label Oct 23, 2018
cjihrig
cjihrig reviewed Oct 23, 2018
View reviewed changes
lib/fs.js Outdated Show resolved Hide resolved
@refack
Copy link
Contributor

refack commented Oct 23, 2018

👍

I had a thought once about doing something like:

function fstat(fd, ...args) {
  const lastArg = args.pop();
  const callback = (typeof lastArg === 'function') ? lastArg : throw ..;
  const options = args.pop() || {};
  ...
}

Actually what we need is a generic arg validator :dream:

function fstat(...args) {
  const { fd, options, callback } = validateArgs(args, { some sort of contract });

@mscdex
Copy link
Contributor

mscdex commented Oct 23, 2018

CI: https://ci.nodejs.org/job/node-test-pull-request/18086/

mhdawson
mhdawson approved these changes Oct 23, 2018
View reviewed changes
Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

lpinca
lpinca reviewed Oct 24, 2018
View reviewed changes
lib/fs.js Outdated
@@ -412,7 +412,7 @@ function open(path, flags, mode, callback) {
path = toPathIfFileURL(path);
validatePath(path);
const flagsNumber = stringToFlags(flags);
if (arguments.length < 4) {
if (typeof mode === 'function') {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this will conflict with @bnoordhuis's work on #23767

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we land #23767 first and then adapt this PR to that change? Seems do-able. /cc @codebytere @bnoordhuis

@Trott
Copy link
Member

Trott commented Nov 6, 2018

@codebytere This seems ready to go if we can get a rebase to resolve the merge conflict with #23767...

@codebytere
Copy link
Member Author

@Trott i'll handle first thing tomorrow!

@codebytere
Copy link
Member Author

codebytere commented Nov 6, 2018 •
edited
Loading

@Trott should be set! i couldn't change this line becuase if i simply checked for flags being a function that didn't properly account for the error case where no callback was passed (i.e. only one arg passed) and would improperly fail tests with ERR_INVALID_OPT_VALUE instead of ERR_INVALID_CALLBACK.

@refack
Copy link
Contributor

refack commented Nov 6, 2018

CI: https://ci.nodejs.org/job/node-test-pull-request/18378/

@refack refack added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Nov 6, 2018
@Trott
Copy link
Member

Trott commented Nov 8, 2018

Landed in 7cf5679

@Trott Trott closed this Nov 8, 2018
Trott pushed a commit to Trott/io.js that referenced this pull request Nov 8, 2018
@codebytere @Trott
src: prefer param function check over args length
7cf5679 
PR-URL: nodejs#23835
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: Matheus Marchini <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: John-David Dalton <[email protected]>
Reviewed-By: Yuta Hiroto <[email protected]>
BridgeAR pushed a commit that referenced this pull request Nov 14, 2018
@codebytere @BridgeAR
src: prefer param function check over args length
17e80ec 
PR-URL: #23835
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: Matheus Marchini <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: John-David Dalton <[email protected]>
Reviewed-By: Yuta Hiroto <[email protected]>
@BridgeAR BridgeAR mentioned this pull request Nov 14, 2018
Merged
kiyomizumia pushed a commit to kiyomizumia/node that referenced this pull request Nov 15, 2018
@codebytere @kiyomizumia
src: prefer param function check over args length
39b6b82 
PR-URL: nodejs#23835
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: Matheus Marchini <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: John-David Dalton <[email protected]>
Reviewed-By: Yuta Hiroto <[email protected]>
This was referenced Nov 15, 2018
Closed
Closed
Closed
This was referenced Nov 16, 2018
Closed
Closed
Closed
codebytere added a commit that referenced this pull request Nov 29, 2018
@codebytere
src: prefer param function check over args length
58e9cca 
PR-URL: #23835
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: Matheus Marchini <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: John-David Dalton <[email protected]>
Reviewed-By: Yuta Hiroto <[email protected]>
MylesBorins pushed a commit that referenced this pull request Nov 29, 2018
@codebytere @MylesBorins
src: prefer param function check over args length
a273da9 
PR-URL: #23835
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: Matheus Marchini <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: John-David Dalton <[email protected]>
Reviewed-By: Yuta Hiroto <[email protected]>
@codebytere codebytere mentioned this pull request Nov 29, 2018
Merged
MylesBorins pushed a commit that referenced this pull request Dec 3, 2018
@codebytere @MylesBorins
src: prefer param function check over args length
9106ccf 
PR-URL: #23835
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: Matheus Marchini <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: John-David Dalton <[email protected]>
Reviewed-By: Yuta Hiroto <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lpinca lpinca lpinca left review comments

@Trott Trott Trott left review comments

@mhdawson mhdawson mhdawson approved these changes

@mmarchini mmarchini mmarchini approved these changes

@hiroppy hiroppy hiroppy approved these changes

@cjihrig cjihrig cjihrig approved these changes

@addaleax addaleax addaleax approved these changes

@jasnell jasnell jasnell approved these changes

@refack refack refack approved these changes

@jdalton jdalton jdalton approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. fs Issues and PRs related to the fs subsystem / file system.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.