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

url: update url module to use module.exports = {} pattern #12717

Closed
wants to merge 2 commits into from
Closed

url: update url module to use module.exports = {} pattern #12717

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8320c33
url: move to module.exports = {} pattern
jasnell Apr 28, 2017
123e699
url: refactor binding imports in internal/url
jasnell Apr 28, 2017
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
140 changes: 79 additions & 61 deletions lib/internal/url.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,44 @@ const {
hexTable,
isHexTable
} = require('internal/querystring');

const { getConstructorOf } = require('internal/util');
const errors = require('internal/errors');
const binding = process.binding('url');
const querystring = require('querystring');

const { platform } = process;
const isWindows = platform === 'win32';

const {
domainToASCII: _domainToASCII,
domainToUnicode: _domainToUnicode,
encodeAuth,
toUSVString: _toUSVString,
parse: _parse,
setURLConstructor,
URL_FLAGS_CANNOT_BE_BASE,
URL_FLAGS_HAS_FRAGMENT,
URL_FLAGS_HAS_HOST,
URL_FLAGS_HAS_PASSWORD,
URL_FLAGS_HAS_PATH,
URL_FLAGS_HAS_QUERY,
URL_FLAGS_HAS_USERNAME,
URL_FLAGS_SPECIAL,
kFragment,
kHost,
kHostname,
kPathStart,
kPort,
kQuery,
kSchemeStart
} = process.binding('url');

const context = Symbol('context');
const cannotBeBase = Symbol('cannot-be-base');
const cannotHaveUsernamePasswordPort =
Symbol('cannot-have-username-password-port');
const special = Symbol('special');
const searchParams = Symbol('query');
const querystring = require('querystring');

const { platform } = process;
const isWindows = platform === 'win32';

const kFormat = Symbol('format');

// https://tc39.github.io/ecma262/#sec-%iteratorprototype%-object
Expand All @@ -35,7 +59,7 @@ function toUSVString(val) {
const match = unpairedSurrogateRe.exec(str);
if (!match)
return str;
return binding.toUSVString(str, match.index);
return _toUSVString(str, match.index);
}

// Refs: https://html.spec.whatwg.org/multipage/browsers.html#concept-origin-opaque
Expand Down Expand Up @@ -74,10 +98,10 @@ function onParseComplete(flags, protocol, username, password,
var ctx = this[context];
ctx.flags = flags;
ctx.scheme = protocol;
ctx.username = (flags & binding.URL_FLAGS_HAS_USERNAME) !== 0 ? username : '';
ctx.password = (flags & binding.URL_FLAGS_HAS_PASSWORD) !== 0 ? password : '';
ctx.username = (flags & URL_FLAGS_HAS_USERNAME) !== 0 ? username : '';
ctx.password = (flags & URL_FLAGS_HAS_PASSWORD) !== 0 ? password : '';
ctx.port = port;
ctx.path = (flags & binding.URL_FLAGS_HAS_PATH) !== 0 ? path : [];
ctx.path = (flags & URL_FLAGS_HAS_PATH) !== 0 ? path : [];
ctx.query = query;
ctx.fragment = fragment;
ctx.host = host;
Expand All @@ -98,31 +122,30 @@ function onParseError(flags, input) {
function parse(url, input, base) {
const base_context = base ? base[context] : undefined;
url[context] = new URLContext();
binding.parse(input.trim(), -1,
base_context, undefined,
onParseComplete.bind(url), onParseError);
_parse(input.trim(), -1, base_context, undefined,
onParseComplete.bind(url), onParseError);
}

function onParseProtocolComplete(flags, protocol, username, password,
host, port, path, query, fragment) {
const ctx = this[context];
if ((flags & binding.URL_FLAGS_SPECIAL) !== 0) {
ctx.flags |= binding.URL_FLAGS_SPECIAL;
if ((flags & URL_FLAGS_SPECIAL) !== 0) {
ctx.flags |= URL_FLAGS_SPECIAL;
} else {
ctx.flags &= ~binding.URL_FLAGS_SPECIAL;
ctx.flags &= ~URL_FLAGS_SPECIAL;
}
ctx.scheme = protocol;
}

function onParseHostComplete(flags, protocol, username, password,
host, port, path, query, fragment) {
const ctx = this[context];
if ((flags & binding.URL_FLAGS_HAS_HOST) !== 0) {
if ((flags & URL_FLAGS_HAS_HOST) !== 0) {
ctx.host = host;
ctx.flags |= binding.URL_FLAGS_HAS_HOST;
ctx.flags |= URL_FLAGS_HAS_HOST;
} else {
ctx.host = null;
ctx.flags &= ~binding.URL_FLAGS_HAS_HOST;
ctx.flags &= ~URL_FLAGS_HAS_HOST;
}
if (port !== null)
ctx.port = port;
Expand All @@ -131,12 +154,12 @@ function onParseHostComplete(flags, protocol, username, password,
function onParseHostnameComplete(flags, protocol, username, password,
host, port, path, query, fragment) {
const ctx = this[context];
if ((flags & binding.URL_FLAGS_HAS_HOST) !== 0) {
if ((flags & URL_FLAGS_HAS_HOST) !== 0) {
ctx.host = host;
ctx.flags |= binding.URL_FLAGS_HAS_HOST;
ctx.flags |= URL_FLAGS_HAS_HOST;
} else {
ctx.host = null;
ctx.flags &= ~binding.URL_FLAGS_HAS_HOST;
ctx.flags &= ~URL_FLAGS_HAS_HOST;
}
}

Expand All @@ -148,18 +171,18 @@ function onParsePortComplete(flags, protocol, username, password,
function onParsePathComplete(flags, protocol, username, password,
host, port, path, query, fragment) {
const ctx = this[context];
if ((flags & binding.URL_FLAGS_HAS_PATH) !== 0) {
if ((flags & URL_FLAGS_HAS_PATH) !== 0) {
ctx.path = path;
ctx.flags |= binding.URL_FLAGS_HAS_PATH;
ctx.flags |= URL_FLAGS_HAS_PATH;
} else {
ctx.path = [];
ctx.flags &= ~binding.URL_FLAGS_HAS_PATH;
ctx.flags &= ~URL_FLAGS_HAS_PATH;
}

// The C++ binding may set host to empty string.
if ((flags & binding.URL_FLAGS_HAS_HOST) !== 0) {
if ((flags & URL_FLAGS_HAS_HOST) !== 0) {
ctx.host = host;
ctx.flags |= binding.URL_FLAGS_HAS_HOST;
ctx.flags |= URL_FLAGS_HAS_HOST;
}
}

Expand All @@ -185,11 +208,11 @@ class URL {
}

get [special]() {
return (this[context].flags & binding.URL_FLAGS_SPECIAL) !== 0;
return (this[context].flags & URL_FLAGS_SPECIAL) !== 0;
}

get [cannotBeBase]() {
return (this[context].flags & binding.URL_FLAGS_CANNOT_BE_BASE) !== 0;
return (this[context].flags & URL_FLAGS_CANNOT_BE_BASE) !== 0;
}

// https://url.spec.whatwg.org/#cannot-have-a-username-password-port
Expand Down Expand Up @@ -348,8 +371,8 @@ Object.defineProperties(URL.prototype, {
(ctx.host === '' || ctx.host === null)) {
return;
}
binding.parse(scheme, binding.kSchemeStart, null, ctx,
onParseProtocolComplete.bind(this));
_parse(scheme, kSchemeStart, null, ctx,
onParseProtocolComplete.bind(this));
}
},
username: {
Expand All @@ -366,11 +389,11 @@ Object.defineProperties(URL.prototype, {
const ctx = this[context];
if (username === '') {
ctx.username = '';
ctx.flags &= ~binding.URL_FLAGS_HAS_USERNAME;
ctx.flags &= ~URL_FLAGS_HAS_USERNAME;
return;
}
ctx.username = binding.encodeAuth(username);
ctx.flags |= binding.URL_FLAGS_HAS_USERNAME;
ctx.username = encodeAuth(username);
ctx.flags |= URL_FLAGS_HAS_USERNAME;
}
},
password: {
Expand All @@ -387,11 +410,11 @@ Object.defineProperties(URL.prototype, {
const ctx = this[context];
if (password === '') {
ctx.password = '';
ctx.flags &= ~binding.URL_FLAGS_HAS_PASSWORD;
ctx.flags &= ~URL_FLAGS_HAS_PASSWORD;
return;
}
ctx.password = binding.encodeAuth(password);
ctx.flags |= binding.URL_FLAGS_HAS_PASSWORD;
ctx.password = encodeAuth(password);
ctx.flags |= URL_FLAGS_HAS_PASSWORD;
}
},
host: {
Expand All @@ -412,8 +435,7 @@ Object.defineProperties(URL.prototype, {
// Cannot set the host if cannot-be-base is set
return;
}
binding.parse(host, binding.kHost, null, ctx,
onParseHostComplete.bind(this));
_parse(host, kHost, null, ctx, onParseHostComplete.bind(this));
}
},
hostname: {
Expand All @@ -430,8 +452,7 @@ Object.defineProperties(URL.prototype, {
// Cannot set the host if cannot-be-base is set
return;
}
binding.parse(host, binding.kHostname, null, ctx,
onParseHostnameComplete.bind(this));
_parse(host, kHostname, null, ctx, onParseHostnameComplete.bind(this));
}
},
port: {
Expand All @@ -451,8 +472,7 @@ Object.defineProperties(URL.prototype, {
ctx.port = null;
return;
}
binding.parse(port, binding.kPort, null, ctx,
onParsePortComplete.bind(this));
_parse(port, kPort, null, ctx, onParsePortComplete.bind(this));
}
},
pathname: {
Expand All @@ -471,8 +491,8 @@ Object.defineProperties(URL.prototype, {
path = `${path}`;
if (this[cannotBeBase])
return;
binding.parse(path, binding.kPathStart, null, this[context],
onParsePathComplete.bind(this));
_parse(path, kPathStart, null, this[context],
onParsePathComplete.bind(this));
}
},
search: {
Expand All @@ -489,14 +509,13 @@ Object.defineProperties(URL.prototype, {
search = toUSVString(search);
if (search === '') {
ctx.query = null;
ctx.flags &= ~binding.URL_FLAGS_HAS_QUERY;
ctx.flags &= ~URL_FLAGS_HAS_QUERY;
} else {
if (search[0] === '?') search = search.slice(1);
ctx.query = '';
ctx.flags |= binding.URL_FLAGS_HAS_QUERY;
ctx.flags |= URL_FLAGS_HAS_QUERY;
if (search) {
binding.parse(search, binding.kQuery, null, ctx,
onParseSearchComplete.bind(this));
_parse(search, kQuery, null, ctx, onParseSearchComplete.bind(this));
}
}
initSearchParams(this[searchParams], search);
Expand Down Expand Up @@ -524,14 +543,13 @@ Object.defineProperties(URL.prototype, {
hash = `${hash}`;
if (!hash) {
ctx.fragment = null;
ctx.flags &= ~binding.URL_FLAGS_HAS_FRAGMENT;
ctx.flags &= ~URL_FLAGS_HAS_FRAGMENT;
return;
}
if (hash[0] === '#') hash = hash.slice(1);
ctx.fragment = '';
ctx.flags |= binding.URL_FLAGS_HAS_FRAGMENT;
binding.parse(hash, binding.kFragment, null, ctx,
onParseHashComplete.bind(this));
ctx.flags |= URL_FLAGS_HAS_FRAGMENT;
_parse(hash, kFragment, null, ctx, onParseHashComplete.bind(this));
}
},
toJSON: {
Expand All @@ -553,10 +571,10 @@ function update(url, params) {
const serializedParams = params.toString();
if (serializedParams) {
ctx.query = serializedParams;
ctx.flags |= binding.URL_FLAGS_HAS_QUERY;
ctx.flags |= URL_FLAGS_HAS_QUERY;
} else {
ctx.query = null;
ctx.flags &= ~binding.URL_FLAGS_HAS_QUERY;
ctx.flags &= ~URL_FLAGS_HAS_QUERY;
}
}

Expand Down Expand Up @@ -1257,15 +1275,15 @@ function domainToASCII(domain) {
throw new errors.TypeError('ERR_MISSING_ARGS', 'domain');

// toUSVString is not needed.
return binding.domainToASCII(`${domain}`);
return _domainToASCII(`${domain}`);
}

function domainToUnicode(domain) {
if (arguments.length < 1)
throw new errors.TypeError('ERR_MISSING_ARGS', 'domain');

// toUSVString is not needed.
return binding.domainToUnicode(`${domain}`);
return _domainToUnicode(`${domain}`);
}

// Utility function that converts a URL object into an ordinary
Expand Down Expand Up @@ -1365,10 +1383,10 @@ function constructUrl(flags, protocol, username, password,
var ctx = new URLContext();
ctx.flags = flags;
ctx.scheme = protocol;
ctx.username = (flags & binding.URL_FLAGS_HAS_USERNAME) !== 0 ? username : '';
ctx.password = (flags & binding.URL_FLAGS_HAS_PASSWORD) !== 0 ? password : '';
ctx.username = (flags & URL_FLAGS_HAS_USERNAME) !== 0 ? username : '';
ctx.password = (flags & URL_FLAGS_HAS_PASSWORD) !== 0 ? password : '';
ctx.port = port;
ctx.path = (flags & binding.URL_FLAGS_HAS_PATH) !== 0 ? path : [];
ctx.path = (flags & URL_FLAGS_HAS_PATH) !== 0 ? path : [];
ctx.query = query;
ctx.fragment = fragment;
ctx.host = host;
Expand All @@ -1378,7 +1396,7 @@ function constructUrl(flags, protocol, username, password,
initSearchParams(url[searchParams], query);
return url;
}
binding.setURLConstructor(constructUrl);
setURLConstructor(constructUrl);

module.exports = {
toUSVString,
Expand Down
37 changes: 26 additions & 11 deletions lib/url.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,19 @@

const { toASCII } = process.binding('config').hasIntl ?
process.binding('icu') : require('punycode');

const { hexTable } = require('internal/querystring');
const internalUrl = require('internal/url');
exports.parse = urlParse;
exports.resolve = urlResolve;
exports.resolveObject = urlResolveObject;
exports.format = urlFormat;
exports.URL = internalUrl.URL;
exports.URLSearchParams = internalUrl.URLSearchParams;
exports.domainToASCII = internalUrl.domainToASCII;
exports.domainToUnicode = internalUrl.domainToUnicode;

// WHATWG URL implementation provided by internal/url
const {
URL,
URLSearchParams,
domainToASCII,
domainToUnicode,
formatSymbol
} = require('internal/url');

exports.Url = Url;
// Original url.parse() API

function Url() {
this.protocol = null;
Expand Down Expand Up @@ -559,7 +559,7 @@ function urlFormat(obj, options) {
throw new TypeError('Parameter "urlObj" must be an object, not ' +
(obj === null ? 'null' : typeof obj));
} else if (!(obj instanceof Url)) {
var format = obj[internalUrl.formatSymbol];
var format = obj[formatSymbol];
return format ?
format.call(obj, options) :
Url.prototype.format.call(obj);
Expand Down Expand Up @@ -1030,3 +1030,18 @@ function encodeAuth(str) {
return out + str.slice(lastPos);
return out;
}

module.exports = {
// Original API
Url,
parse: urlParse,
resolve: urlResolve,
resolveObject: urlResolveObject,
format: urlFormat,

// WHATWG API
URL,
URLSearchParams,
domainToASCII,
domainToUnicode
};