Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2025-04-03 04:52:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Bug 1319926 - Part 1: Warn when deprecated String generics methods are used. r=jandem

Browse Source
This commit is contained in:
André Bargull 2016-11-24 08:58:02 -08:00
parent 17991b4c62
commit 7c06eb05a0
7 changed files with 151 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
js/src/builtin/SelfHostingDefines.h
View File

@ -100,4 +100,30 @@
#define MODULE_STATE_INSTANTIATED 2
#define MODULE_STATE_EVALUATED 3
#define STRING_GENERICS_CHAR_AT 0
#define STRING_GENERICS_CHAR_CODE_AT 1
#define STRING_GENERICS_CONCAT 2
#define STRING_GENERICS_ENDS_WITH 3
#define STRING_GENERICS_INCLUDES 4
#define STRING_GENERICS_INDEX_OF 5
#define STRING_GENERICS_LAST_INDEX_OF 6
#define STRING_GENERICS_LOCALE_COMPARE 7
#define STRING_GENERICS_MATCH 8
#define STRING_GENERICS_NORMALIZE 9
#define STRING_GENERICS_REPLACE 10
#define STRING_GENERICS_SEARCH 11
#define STRING_GENERICS_SLICE 12
#define STRING_GENERICS_SPLIT 13
#define STRING_GENERICS_STARTS_WITH 14
#define STRING_GENERICS_SUBSTR 15
#define STRING_GENERICS_SUBSTRING 16
#define STRING_GENERICS_TO_LOWER_CASE 17
#define STRING_GENERICS_TO_LOCALE_LOWER_CASE 18
#define STRING_GENERICS_TO_LOCALE_UPPER_CASE 19
#define STRING_GENERICS_TO_UPPER_CASE 20
#define STRING_GENERICS_TRIM 21
#define STRING_GENERICS_TRIM_LEFT 22
#define STRING_GENERICS_TRIM_RIGHT 23
#define STRING_GENERICS_METHODS_LIMIT 24
#endif

24
js/src/builtin/String.js
View File

@ -58,6 +58,7 @@ function String_match(regexp) {
}
function String_generic_match(thisValue, regexp) {
WarnDeprecatedStringMethod(STRING_GENERICS_MATCH, 'match');
if (thisValue === undefined)
ThrowTypeError(JSMSG_MISSING_FUN_ARG, 0, 'String.match');
return callFunction(String_match, thisValue, regexp);
@ -192,6 +193,7 @@ function String_replace(searchValue, replaceValue) {
}
function String_generic_replace(thisValue, searchValue, replaceValue) {
WarnDeprecatedStringMethod(STRING_GENERICS_REPLACE, 'replace');
if (thisValue === undefined)
ThrowTypeError(JSMSG_MISSING_FUN_ARG, 0, 'String.replace');
return callFunction(String_replace, thisValue, searchValue, replaceValue);
@ -247,6 +249,7 @@ function String_search(regexp) {
}
function String_generic_search(thisValue, regexp) {
WarnDeprecatedStringMethod(STRING_GENERICS_SEARCH, 'search');
if (thisValue === undefined)
ThrowTypeError(JSMSG_MISSING_FUN_ARG, 0, 'String.search');
return callFunction(String_search, thisValue, regexp);
@ -328,6 +331,7 @@ function String_split(separator, limit) {
}
function String_generic_split(thisValue, separator, limit) {
WarnDeprecatedStringMethod(STRING_GENERICS_SPLIT, 'split');
if (thisValue === undefined)
ThrowTypeError(JSMSG_MISSING_FUN_ARG, 0, 'String.split');
return callFunction(String_split, thisValue, separator, limit);
@ -372,6 +376,7 @@ function String_substring(start, end) {
}
function String_static_substring(string, start, end) {
WarnDeprecatedStringMethod(STRING_GENERICS_SUBSTRING, 'substring');
if (arguments.length < 1)
ThrowTypeError(JSMSG_MISSING_FUN_ARG, 0, 'String.substring');
return callFunction(String_substring, string, start, end);
@ -411,6 +416,7 @@ function String_substr(start, length) {
}
function String_static_substr(string, start, length) {
WarnDeprecatedStringMethod(STRING_GENERICS_SUBSTR, 'substr');
if (arguments.length < 1)
ThrowTypeError(JSMSG_MISSING_FUN_ARG, 0, 'String.substr');
return callFunction(String_substr, string, start, length);
@ -448,6 +454,7 @@ function String_slice(start, end) {
}
function String_static_slice(string, start, end) {
WarnDeprecatedStringMethod(STRING_GENERICS_SLICE, 'slice');
if (arguments.length < 1)
ThrowTypeError(JSMSG_MISSING_FUN_ARG, 0, 'String.slice');
return callFunction(String_slice, string, start, end);
@ -655,6 +662,7 @@ function String_static_raw(callSite, ...substitutions) {
* Spec: https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String#String_generic_methods
*/
function String_static_localeCompare(str1, str2) {
WarnDeprecatedStringMethod(STRING_GENERICS_LOCALE_COMPARE, 'localeCompare');
if (arguments.length < 1)
ThrowTypeError(JSMSG_MISSING_FUN_ARG, 0, "String.localeCompare");
var locales = arguments.length > 2 ? arguments[2] : undefined;
@ -767,30 +775,35 @@ function String_link(url) {
}
function String_static_toLowerCase(string) {
WarnDeprecatedStringMethod(STRING_GENERICS_TO_LOWER_CASE, 'toLowerCase');
if (arguments.length < 1)
ThrowTypeError(JSMSG_MISSING_FUN_ARG, 0, 'String.toLowerCase');
return callFunction(std_String_toLowerCase, string);
}
function String_static_toUpperCase(string) {
WarnDeprecatedStringMethod(STRING_GENERICS_TO_UPPER_CASE, 'toUpperCase');
if (arguments.length < 1)
ThrowTypeError(JSMSG_MISSING_FUN_ARG, 0, 'String.toUpperCase');
return callFunction(std_String_toUpperCase, string);
}
function String_static_charAt(string, pos) {
WarnDeprecatedStringMethod(STRING_GENERICS_CHAR_AT, 'charAt');
if (arguments.length < 1)
ThrowTypeError(JSMSG_MISSING_FUN_ARG, 0, 'String.charAt');
return callFunction(std_String_charAt, string, pos);
}
function String_static_charCodeAt(string, pos) {
WarnDeprecatedStringMethod(STRING_GENERICS_CHAR_CODE_AT, 'charCodeAt');
if (arguments.length < 1)
ThrowTypeError(JSMSG_MISSING_FUN_ARG, 0, 'String.charCodeAt');
return callFunction(std_String_charCodeAt, string, pos);
}
function String_static_includes(string, searchString) {
WarnDeprecatedStringMethod(STRING_GENERICS_INCLUDES, 'includes');
if (arguments.length < 1)
ThrowTypeError(JSMSG_MISSING_FUN_ARG, 0, 'String.includes');
var position = arguments.length > 2 ? arguments[2] : undefined;
@ -798,6 +811,7 @@ function String_static_includes(string, searchString) {
}
function String_static_indexOf(string, searchString) {
WarnDeprecatedStringMethod(STRING_GENERICS_INDEX_OF, 'indexOf');
if (arguments.length < 1)
ThrowTypeError(JSMSG_MISSING_FUN_ARG, 0, 'String.indexOf');
var position = arguments.length > 2 ? arguments[2] : undefined;
@ -805,6 +819,7 @@ function String_static_indexOf(string, searchString) {
}
function String_static_lastIndexOf(string, searchString) {
WarnDeprecatedStringMethod(STRING_GENERICS_LAST_INDEX_OF, 'lastIndexOf');
if (arguments.length < 1)
ThrowTypeError(JSMSG_MISSING_FUN_ARG, 0, 'String.lastIndexOf');
var position = arguments.length > 2 ? arguments[2] : undefined;
@ -812,6 +827,7 @@ function String_static_lastIndexOf(string, searchString) {
}
function String_static_startsWith(string, searchString) {
WarnDeprecatedStringMethod(STRING_GENERICS_STARTS_WITH, 'startsWith');
if (arguments.length < 1)
ThrowTypeError(JSMSG_MISSING_FUN_ARG, 0, 'String.startsWith');
var position = arguments.length > 2 ? arguments[2] : undefined;
@ -819,6 +835,7 @@ function String_static_startsWith(string, searchString) {
}
function String_static_endsWith(string, searchString) {
WarnDeprecatedStringMethod(STRING_GENERICS_ENDS_WITH, 'endsWith');
if (arguments.length < 1)
ThrowTypeError(JSMSG_MISSING_FUN_ARG, 0, 'String.endsWith');
var endPosition = arguments.length > 2 ? arguments[2] : undefined;
@ -826,30 +843,35 @@ function String_static_endsWith(string, searchString) {
}
function String_static_trim(string) {
WarnDeprecatedStringMethod(STRING_GENERICS_TRIM, 'trim');
if (arguments.length < 1)
ThrowTypeError(JSMSG_MISSING_FUN_ARG, 0, 'String.trim');
return callFunction(std_String_trim, string);
}
function String_static_trimLeft(string) {
WarnDeprecatedStringMethod(STRING_GENERICS_TRIM_LEFT, 'trimLeft');
if (arguments.length < 1)
ThrowTypeError(JSMSG_MISSING_FUN_ARG, 0, 'String.trimLeft');
return callFunction(std_String_trimLeft, string);
}
function String_static_trimRight(string) {
WarnDeprecatedStringMethod(STRING_GENERICS_TRIM_RIGHT, 'trimRight');
if (arguments.length < 1)
ThrowTypeError(JSMSG_MISSING_FUN_ARG, 0, 'String.trimRight');
return callFunction(std_String_trimRight, string);
}
function String_static_toLocaleLowerCase(string) {
WarnDeprecatedStringMethod(STRING_GENERICS_TO_LOCALE_LOWER_CASE, 'toLocaleLowerCase');
if (arguments.length < 1)
ThrowTypeError(JSMSG_MISSING_FUN_ARG, 0, 'String.toLocaleLowerCase');
return callFunction(std_String_toLocaleLowerCase, string);
}
function String_static_toLocaleUpperCase(string) {
WarnDeprecatedStringMethod(STRING_GENERICS_TO_LOCALE_UPPER_CASE, 'toLocaleUpperCase');
if (arguments.length < 1)
ThrowTypeError(JSMSG_MISSING_FUN_ARG, 0, 'String.toLocaleUpperCase');
return callFunction(std_String_toLocaleUpperCase, string);
@ -857,6 +879,7 @@ function String_static_toLocaleUpperCase(string) {
#if EXPOSE_INTL_API
function String_static_normalize(string) {
WarnDeprecatedStringMethod(STRING_GENERICS_NORMALIZE, "normalize");
if (arguments.length < 1)
ThrowTypeError(JSMSG_MISSING_FUN_ARG, 0, 'String.normalize');
var form = arguments.length > 1 ? arguments[1] : undefined;
@ -865,6 +888,7 @@ function String_static_normalize(string) {
#endif
function String_static_concat(string, arg1) {
WarnDeprecatedStringMethod(STRING_GENERICS_CONCAT, 'concat');
if (arguments.length < 1)
ThrowTypeError(JSMSG_MISSING_FUN_ARG, 0, 'String.concat');
var args = callFunction(std_Array_slice, arguments, 1);

1
js/src/js.msg
View File

@ -133,6 +133,7 @@ MSG_DEF(JSMSG_INVALID_NORMALIZE_FORM, 0, JSEXN_RANGEERR, "form must be one of '
MSG_DEF(JSMSG_NEGATIVE_REPETITION_COUNT, 0, JSEXN_RANGEERR, "repeat count must be non-negative")
MSG_DEF(JSMSG_NOT_A_CODEPOINT, 1, JSEXN_RANGEERR, "{0} is not a valid code point")
MSG_DEF(JSMSG_RESULTING_STRING_TOO_LARGE, 0, JSEXN_RANGEERR, "repeat count must be less than infinity and not overflow maximum string size")
MSG_DEF(JSMSG_DEPRECATED_STRING_METHOD, 2, JSEXN_WARN, "String.{0} is deprecated; use String.prototype.{1} instead")
// Number
MSG_DEF(JSMSG_BAD_RADIX, 0, JSEXN_RANGEERR, "radix must be an integer at least 2 and no greater than 36")

1
js/src/jscompartment.cpp
View File

@ -55,6 +55,7 @@ JSCompartment::JSCompartment(Zone* zone, const JS::CompartmentOptions& options =
marked(true),
warnedAboutExprClosure(false),
warnedAboutForEach(false),
warnedAboutStringGenericsMethods(0),
#ifdef DEBUG
firedOnNewGlobalObject(false),
#endif

1
js/src/jscompartment.h
View File

@ -361,6 +361,7 @@ struct JSCompartment
bool marked;
bool warnedAboutExprClosure;
bool warnedAboutForEach;
uint32_t warnedAboutStringGenericsMethods;
#ifdef DEBUG
bool firedOnNewGlobalObject;

63
js/src/tests/js1_6/String/generics-deprecated.js Normal file
View File

@ -0,0 +1,63 @@
// |reftest| skip-if(!xulRuntime.shell)
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
// Warn once for each String generics method.
var methods = {
charAt: ["", 0],
charCodeAt: ["", 0],
concat: ["", ""],
endsWith: ["", ""],
includes: ["", ""],
indexOf: ["", ""],
lastIndexOf: ["", ""],
localeCompare: ["", ""],
match: ["", ""],
normalize: [""],
replace: ["", ""],
search: ["", ""],
slice: ["", 0],
split: ["", ""],
startsWith: ["", ""],
substr: ["", 0],
substring: ["", 0],
toLowerCase: [""],
toLocaleLowerCase: [""],
toLocaleUpperCase: [""],
toUpperCase: [""],
trim: [""],
trimLeft: [""],
trimRight: [""]
};
for (var name in methods) {
var args = methods[name];
// String.normalize not available on every platform.
if (name === "normalize" && !(name in String.prototype))
continue;
enableLastWarning();
String[name].apply(null, args);
var warning = getLastWarning();
assertEq(warning !== null, true, "warning should be emitted for " + name);
assertEq(warning.name, "Warning");
assertEq(warning.message.indexOf(name) !== -1, true,
"warning should mention " + name);
clearLastWarning();
String[name].apply(null, args);
warning = getLastWarning();
assertEq(warning, null, "warning shouldn't be emitted for 2nd call to " + name);
disableLastWarning();
}
if (typeof reportCompare === 'function')
reportCompare(0, 0);

35
js/src/vm/SelfHosting.cpp
View File

@ -1904,6 +1904,40 @@ intrinsic_AddContentTelemetry(JSContext* cx, unsigned argc, Value* vp)
return true;
}
static bool
intrinsic_WarnDeprecatedStringMethod(JSContext* cx, unsigned argc, Value* vp)
{
CallArgs args = CallArgsFromVp(argc, vp);
MOZ_ASSERT(args.length() == 2);
MOZ_ASSERT(args[0].isInt32());
MOZ_ASSERT(args[1].isString());
uint32_t id = uint32_t(args[0].toInt32());
MOZ_ASSERT(id < STRING_GENERICS_METHODS_LIMIT);
uint32_t mask = (1 << id);
if (!(cx->compartment()->warnedAboutStringGenericsMethods & mask)) {
JSFlatString* name = args[1].toString()->ensureFlat(cx);
if (!name)
return false;
AutoStableStringChars stableChars(cx);
if (!stableChars.initTwoByte(cx, name))
return false;
const char16_t* nameChars = stableChars.twoByteRange().begin().get();
if (!JS_ReportErrorFlagsAndNumberUC(cx, JSREPORT_WARNING, GetErrorMessage, nullptr,
JSMSG_DEPRECATED_STRING_METHOD, nameChars, nameChars))
{
return false;
}
cx->compartment()->warnedAboutStringGenericsMethods |= mask;
}
args.rval().setUndefined();
return true;
}
static bool
intrinsic_ConstructFunction(JSContext* cx, unsigned argc, Value* vp)
{
@ -2513,6 +2547,7 @@ static const JSFunctionSpec intrinsic_functions[] = {
JS_INLINABLE_FN("StringSplitString", intrinsic_StringSplitString, 2, 0,
IntrinsicStringSplitString),
JS_FN("StringSplitStringLimit", intrinsic_StringSplitStringLimit, 3, 0),
JS_FN("WarnDeprecatedStringMethod", intrinsic_WarnDeprecatedStringMethod, 2, 0),
// See builtin/RegExp.h for descriptions of the regexp_* functions.
JS_FN("regexp_exec_no_statics", regexp_exec_no_statics, 2,0),