Skip to content

Commit 8a38aed

Browse files
anonriganonrig
committed
url: simplify and improve url formatting
PR-URL: #46736 Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 910d27e commit 8a38aed

File tree

4 files changed

+111
-110
lines changed

4 files changed

+111
-110
lines changed

‎lib/internal/url.js‎

Lines changed: 13 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,6 @@ const path = require('path');
7878

7979
const {
8080
validateFunction,
81-
validateObject,
8281
} = require('internal/validators');
8382

8483
const querystring = require('querystring');
@@ -151,8 +150,6 @@ class URLContext {
151150
password = '';
152151
port = '';
153152
hash = '';
154-
hasHost = false;
155-
hasOpaquePath = false;
156153
}
157154

158155
function isURLSearchParams(self) {
@@ -283,7 +280,9 @@ class URLSearchParams {
283280
name = toUSVString(name);
284281
value = toUSVString(value);
285282
ArrayPrototypePush(this[searchParams], name, value);
286-
update(this[context], this);
283+
if (this[context]) {
284+
this[context].search = this.toString();
285+
}
287286
}
288287

289288
delete(name) {
@@ -304,7 +303,9 @@ class URLSearchParams {
304303
i += 2;
305304
}
306305
}
307-
update(this[context], this);
306+
if (this[context]) {
307+
this[context].search = this.toString();
308+
}
308309
}
309310

310311
get(name) {
@@ -399,7 +400,9 @@ class URLSearchParams {
399400
ArrayPrototypePush(list, name, value);
400401
}
401402

402-
update(this[context], this);
403+
if (this[context]) {
404+
this[context].search = this.toString();
405+
}
403406
}
404407

405408
sort() {
@@ -443,7 +446,9 @@ class URLSearchParams {
443446
}
444447
}
445448

446-
update(this[context], this);
449+
if (this[context]) {
450+
this[context].search = this.toString();
451+
}
447452
}
448453

449454
// https://heycam.github.io/webidl/#es-iterators
@@ -529,46 +534,6 @@ function isURLThis(self) {
529534
return (self !== undefined && self !== null && self[context] !== undefined);
530535
}
531536

532-
function constructHref(ctx, options) {
533-
if (options)
534-
validateObject(options, 'options');
535-
536-
options = {
537-
fragment: true,
538-
unicode: false,
539-
search: true,
540-
auth: true,
541-
...options
542-
};
543-
544-
// https://url.spec.whatwg.org/#url-serializing
545-
let ret = ctx.protocol;
546-
if (ctx.hasHost) {
547-
ret += '//';
548-
const hasUsername = ctx.username !== '';
549-
const hasPassword = ctx.password !== '';
550-
if (options.auth && (hasUsername || hasPassword)) {
551-
if (hasUsername)
552-
ret += ctx.username;
553-
if (hasPassword)
554-
ret += `:${ctx.password}`;
555-
ret += '@';
556-
}
557-
ret += options.unicode ?
558-
domainToUnicode(ctx.hostname) : ctx.hostname;
559-
if (ctx.port !== '')
560-
ret += `:${ctx.port}`;
561-
} else if (!ctx.hasOpaquePath && ctx.pathname.lastIndexOf('/') !== 0 && ctx.pathname.startsWith('//')) {
562-
ret += '/.';
563-
}
564-
ret += ctx.pathname;
565-
if (options.search)
566-
ret += ctx.search;
567-
if (options.fragment)
568-
ret += ctx.hash;
569-
return ret;
570-
}
571-
572537
class URL {
573538
constructor(input, base = undefined) {
574539
// toUSVString is not needed.
@@ -621,14 +586,8 @@ class URL {
621586
return `${constructor.name} ${inspect(obj, opts)}`;
622587
}
623588

624-
[kFormat](options) {
625-
// TODO(@anonrig): Replace kFormat with actually calling setters.
626-
return constructHref(this[context], options);
627-
}
628-
629589
#onParseComplete = (href, origin, protocol, hostname, pathname,
630-
search, username, password, port, hash, hasHost,
631-
hasOpaquePath) => {
590+
search, username, password, port, hash) => {
632591
const ctx = this[context];
633592
ctx.href = href;
634593
ctx.origin = origin;
@@ -640,9 +599,6 @@ class URL {
640599
ctx.password = password;
641600
ctx.port = port;
642601
ctx.hash = hash;
643-
// TODO(@anonrig): Remove hasHost and hasOpaquePath when kFormat is removed.
644-
ctx.hasHost = hasHost;
645-
ctx.hasOpaquePath = hasOpaquePath;
646602
if (!this[searchParams]) { // Invoked from URL constructor
647603
this[searchParams] = new URLSearchParams();
648604
this[searchParams][context] = this;
@@ -855,33 +811,6 @@ ObjectDefineProperties(URL, {
855811
revokeObjectURL: kEnumerableProperty,
856812
});
857813

858-
function update(url, params) {
859-
if (!url)
860-
return;
861-
862-
const ctx = url[context];
863-
const serializedParams = params.toString();
864-
if (serializedParams.length > 0) {
865-
ctx.search = '?' + serializedParams;
866-
} else {
867-
ctx.search = '';
868-
869-
// Potentially strip trailing spaces from an opaque path
870-
if (ctx.hasOpaquePath && ctx.hash.length === 0) {
871-
let length = ctx.pathname.length;
872-
while (length > 0 && ctx.pathname.charCodeAt(length - 1) === 32) {
873-
length--;
874-
}
875-
876-
// No need to copy the whole string if there is no space at the end
877-
if (length !== ctx.pathname.length) {
878-
ctx.pathname = ctx.pathname.slice(0, length);
879-
}
880-
}
881-
}
882-
ctx.href = constructHref(ctx);
883-
}
884-
885814
function initSearchParams(url, init) {
886815
if (!init) {
887816
url[searchParams] = [];
@@ -1380,7 +1309,6 @@ module.exports = {
13801309
domainToASCII,
13811310
domainToUnicode,
13821311
urlToHttpOptions,
1383-
formatSymbol: kFormat,
13841312
searchParamsSymbol: searchParams,
13851313
encodeStr
13861314
};

‎lib/url.js‎

Lines changed: 38 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
'use strict';
2323

2424
const {
25+
Boolean,
2526
Int8Array,
2627
ObjectCreate,
2728
ObjectKeys,
@@ -38,7 +39,10 @@ const {
3839
ERR_INVALID_ARG_TYPE,
3940
ERR_INVALID_URL,
4041
} = require('internal/errors').codes;
41-
const { validateString } = require('internal/validators');
42+
const {
43+
validateString,
44+
validateObject,
45+
} = require('internal/validators');
4246

4347
// This ensures setURLConstructor() is called before the native
4448
// URL::ToObject() method is used.
@@ -51,11 +55,14 @@ const {
5155
domainToASCII,
5256
domainToUnicode,
5357
fileURLToPath,
54-
formatSymbol,
5558
pathToFileURL,
5659
urlToHttpOptions,
5760
} = require('internal/url');
5861

62+
const {
63+
formatUrl,
64+
} = internalBinding('url');
65+
5966
// Original url.parse() API
6067

6168
function Url() {
@@ -579,13 +586,36 @@ function urlFormat(urlObject, options) {
579586
} else if (typeof urlObject !== 'object' || urlObject === null) {
580587
throw new ERR_INVALID_ARG_TYPE('urlObject',
581588
['Object', 'string'], urlObject);
582-
} else if (!(urlObject instanceof Url)) {
583-
const format = urlObject[formatSymbol];
584-
return format ?
585-
format.call(urlObject, options) :
586-
Url.prototype.format.call(urlObject);
589+
} else if (urlObject instanceof URL) {
590+
let fragment = true;
591+
let unicode = false;
592+
let search = true;
593+
let auth = true;
594+
595+
if (options) {
596+
validateObject(options, 'options');
597+
598+
if (options.fragment != null) {
599+
fragment = Boolean(options.fragment);
600+
}
601+
602+
if (options.unicode != null) {
603+
unicode = Boolean(options.unicode);
604+
}
605+
606+
if (options.search != null) {
607+
search = Boolean(options.search);
608+
}
609+
610+
if (options.auth != null) {
611+
auth = Boolean(options.auth);
612+
}
613+
}
614+
615+
return formatUrl(urlObject.href, fragment, unicode, search, auth);
587616
}
588-
return urlObject.format();
617+
618+
return Url.prototype.format.call(urlObject);
589619
}
590620

591621
// These characters do not need escaping:

‎src/node_url.cc‎

Lines changed: 59 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111

1212
namespace node {
1313

14-
using v8::Boolean;
1514
using v8::Context;
1615
using v8::Function;
1716
using v8::FunctionCallbackInfo;
@@ -47,7 +46,7 @@ enum url_update_action {
4746
kHref = 9,
4847
};
4948

50-
void SetArgs(Environment* env, Local<Value> argv[12], const ada::result& url) {
49+
void SetArgs(Environment* env, Local<Value> argv[10], const ada::result& url) {
5150
Isolate* isolate = env->isolate();
5251
argv[0] = Utf8String(isolate, url->get_href());
5352
argv[1] = Utf8String(isolate, url->get_origin());
@@ -59,8 +58,6 @@ void SetArgs(Environment* env, Local<Value> argv[12], const ada::result& url) {
5958
argv[7] = Utf8String(isolate, url->get_password());
6059
argv[8] = Utf8String(isolate, url->get_port());
6160
argv[9] = Utf8String(isolate, url->get_hash());
62-
argv[10] = Boolean::New(isolate, url->host.has_value());
63-
argv[11] = Boolean::New(isolate, url->has_opaque_path);
6461
}
6562

6663
void Parse(const FunctionCallbackInfo<Value>& args) {
@@ -86,8 +83,7 @@ void Parse(const FunctionCallbackInfo<Value>& args) {
8683
}
8784
base_pointer = &base.value();
8885
}
89-
ada::result out =
90-
ada::parse(std::string_view(input.out(), input.length()), base_pointer);
86+
ada::result out = ada::parse(input.ToStringView(), base_pointer);
9187

9288
if (!out) {
9389
return args.GetReturnValue().Set(false);
@@ -105,8 +101,6 @@ void Parse(const FunctionCallbackInfo<Value>& args) {
105101
undef,
106102
undef,
107103
undef,
108-
undef,
109-
undef,
110104
};
111105
SetArgs(env, argv, out);
112106
USE(success_callback_->Call(
@@ -192,10 +186,8 @@ void UpdateUrl(const FunctionCallbackInfo<Value>& args) {
192186
Utf8Value new_value(isolate, args[2].As<String>());
193187
Local<Function> success_callback_ = args[3].As<Function>();
194188

195-
std::string_view new_value_view =
196-
std::string_view(new_value.out(), new_value.length());
197-
std::string_view input_view = std::string_view(input.out(), input.length());
198-
ada::result out = ada::parse(input_view);
189+
std::string_view new_value_view = new_value.ToStringView();
190+
ada::result out = ada::parse(input.ToStringView());
199191
CHECK(out);
200192

201193
bool result{true};
@@ -255,21 +247,73 @@ void UpdateUrl(const FunctionCallbackInfo<Value>& args) {
255247
undef,
256248
undef,
257249
undef,
258-
undef,
259-
undef,
260250
};
261251
SetArgs(env, argv, out);
262252
USE(success_callback_->Call(
263253
env->context(), args.This(), arraysize(argv), argv));
264254
args.GetReturnValue().Set(result);
265255
}
266256

257+
void FormatUrl(const FunctionCallbackInfo<Value>& args) {
258+
CHECK_GT(args.Length(), 4);
259+
CHECK(args[0]->IsString()); // url href
260+
261+
Environment* env = Environment::GetCurrent(args);
262+
Isolate* isolate = env->isolate();
263+
264+
Utf8Value href(isolate, args[0].As<String>());
265+
const bool fragment = args[1]->IsTrue();
266+
const bool unicode = args[2]->IsTrue();
267+
const bool search = args[3]->IsTrue();
268+
const bool auth = args[4]->IsTrue();
269+
270+
ada::result out = ada::parse(href.ToStringView());
271+
CHECK(out);
272+
273+
if (!fragment) {
274+
out->fragment = std::nullopt;
275+
}
276+
277+
if (unicode) {
278+
#if defined(NODE_HAVE_I18N_SUPPORT)
279+
std::string hostname = out->get_hostname();
280+
MaybeStackBuffer<char> buf;
281+
int32_t len = i18n::ToUnicode(&buf, hostname.data(), hostname.length());
282+
283+
if (len < 0) {
284+
out->host = "";
285+
} else {
286+
out->host = buf.ToString();
287+
}
288+
#else
289+
out->host = "";
290+
#endif
291+
}
292+
293+
if (!search) {
294+
out->query = std::nullopt;
295+
}
296+
297+
if (!auth) {
298+
out->username = "";
299+
out->password = "";
300+
}
301+
302+
std::string result = out->get_href();
303+
args.GetReturnValue().Set(String::NewFromUtf8(env->isolate(),
304+
result.data(),
305+
NewStringType::kNormal,
306+
result.length())
307+
.ToLocalChecked());
308+
}
309+
267310
void Initialize(Local<Object> target,
268311
Local<Value> unused,
269312
Local<Context> context,
270313
void* priv) {
271314
SetMethod(context, target, "parse", Parse);
272315
SetMethod(context, target, "updateUrl", UpdateUrl);
316+
SetMethod(context, target, "formatUrl", FormatUrl);
273317

274318
SetMethodNoSideEffect(context, target, "domainToASCII", DomainToASCII);
275319
SetMethodNoSideEffect(context, target, "domainToUnicode", DomainToUnicode);
@@ -279,6 +323,7 @@ void Initialize(Local<Object> target,
279323
void RegisterExternalReferences(ExternalReferenceRegistry* registry) {
280324
registry->Register(Parse);
281325
registry->Register(UpdateUrl);
326+
registry->Register(FormatUrl);
282327

283328
registry->Register(DomainToASCII);
284329
registry->Register(DomainToUnicode);

0 commit comments

Comments
 (0)