diff --git a/Gruntfile.js b/Gruntfile.js index eda8d5cf..e0e62123 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -11,20 +11,21 @@ module.exports = function( grunt ) { "dist/jquery-migrate.min.js", "test/data/compareVersions.js", - "test/testinit.js", - "test/migrate.js", - "test/core.js", - "test/ajax.js", - "test/attributes.js", - "test/css.js", - "test/data.js", - "test/deferred.js", - "test/effects.js", - "test/event.js", - "test/manipulation.js", - "test/offset.js", - "test/serialize.js", - "test/traversing.js", + "test/data/testinit.js", + "test/data/test-utils.js", + "test/unit/migrate.js", + "test/unit/jquery/core.js", + "test/unit/jquery/ajax.js", + "test/unit/jquery/attributes.js", + "test/unit/jquery/css.js", + "test/unit/jquery/data.js", + "test/unit/jquery/deferred.js", + "test/unit/jquery/effects.js", + "test/unit/jquery/event.js", + "test/unit/jquery/manipulation.js", + "test/unit/jquery/offset.js", + "test/unit/jquery/serialize.js", + "test/unit/jquery/traversing.js", { pattern: "dist/jquery-migrate.js", included: false, served: true }, { pattern: "test/**/*.@(js|json|css|jpg|html|xml)", included: false, served: true } diff --git a/README.md b/README.md index f929b65a..53849d4e 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,14 @@ This plugin adds some properties to the `jQuery` object that can be used to prog `jQuery.migrateDeduplicateWarnings`: By default, Migrate only gives a specific warning once. If you set this property to `false` it will give a warning for every occurrence each time it happens. Note that this can generate a lot of output, for example when a warning occurs in a loop. +`jQuery.migrateDisablePatches`: Disables patches by their codes. You can find a code for each patch in square brackets in [warnings.md](https://github.com/jquery/jquery-migrate/blob/main/warnings.md). A limited number of warnings doesn't have codes defined and cannot be disabled. These are mostly setup issues like using an incorrect version of jQuery or loading Migrate multiple times. + +`jQuery.migrateDisablePatches`: Disables patches by their codes. + +`jQuery.migrateIsPatchEnabled`: Returns `true` if a patch of a provided code is enabled and `false` otherwise. + +`jQuery.UNSAFE_restoreLegacyHtmlPrefilter`: A deprecated alias of `jQuery.migrateEnablePatches( "self-closed-tags" )` + ## Reporting problems Bugs that only occur when the jQuery Migrate plugin is used should be reported in the [jQuery Migrate Issue Tracker](https://github.com/jquery/jquery-migrate/issues) and should be accompanied by an executable test case that demonstrates the bug. The easiest way to do this is via an online test tool such as [jsFiddle.net](https://jsFiddle.net/) or [jsbin.com](https://jsbin.com). Use the development version when you are reporting bugs. diff --git a/src/disablePatches.js b/src/disablePatches.js new file mode 100644 index 00000000..07238a3c --- /dev/null +++ b/src/disablePatches.js @@ -0,0 +1,33 @@ +// A map from disabled patch codes to `true`. This should really +// be a `Set` but those are unsupported in IE. +var disabledPatches = Object.create( null ); + +// Don't apply patches for specified codes. Helpful for code bases +// where some Migrate warnings have been addressed and it's desirable +// to avoid needless patches or false positives. +jQuery.migrateDisablePatches = function() { + var i; + for ( i = 0; i < arguments.length; i++ ) { + disabledPatches[ arguments[ i ] ] = true; + } +}; + +// Allow enabling patches disabled via `jQuery.migrateDisablePatches`. +// Helpful if you want to disable a patch only for some code that won't +// be updated soon to be able to focus on other warnings - and enable it +// immediately after such a call: +// ```js +// jQuery.migrateDisablePatches( "workaroundA" ); +// elem.pluginViolatingWarningA( "pluginMethod" ); +// jQuery.migrateEnablePatches( "workaroundA" ); +// ``` +jQuery.migrateEnablePatches = function() { + var i; + for ( i = 0; i < arguments.length; i++ ) { + delete disabledPatches[ arguments[ i ] ]; + } +}; + +jQuery.migrateIsPatchEnabled = function( patchCode ) { + return !disabledPatches[ patchCode ]; +}; diff --git a/src/jquery/ajax.js b/src/jquery/ajax.js index 06b24a44..2caf7929 100644 --- a/src/jquery/ajax.js +++ b/src/jquery/ajax.js @@ -1,5 +1,5 @@ import { jQueryVersionSince } from "../compareVersions.js"; -import { migrateWarn, migrateWarnFunc } from "../main.js"; +import { migrateWarn, migratePatchAndWarnFunc, migratePatchFunc } from "../main.js"; // Support jQuery slim which excludes the ajax module if ( jQuery.ajax ) { @@ -7,21 +7,21 @@ if ( jQuery.ajax ) { var oldAjax = jQuery.ajax, rjsonp = /(=)\?(?=&|$)|\?\?/; -jQuery.ajax = function( ) { +migratePatchFunc( jQuery, "ajax", function() { var jQXHR = oldAjax.apply( this, arguments ); // Be sure we got a jQXHR (e.g., not sync) if ( jQXHR.promise ) { - migrateWarnFunc( jQXHR, "success", jQXHR.done, + migratePatchAndWarnFunc( jQXHR, "success", jQXHR.done, "jqXHR-methods", "jQXHR.success is deprecated and removed" ); - migrateWarnFunc( jQXHR, "error", jQXHR.fail, + migratePatchAndWarnFunc( jQXHR, "error", jQXHR.fail, "jqXHR-methods", "jQXHR.error is deprecated and removed" ); - migrateWarnFunc( jQXHR, "complete", jQXHR.always, + migratePatchAndWarnFunc( jQXHR, "complete", jQXHR.always, "jqXHR-methods", "jQXHR.complete is deprecated and removed" ); } return jQXHR; -}; +}, "jqXHR-methods" ); // Only trigger the logic in jQuery <4 as the JSON-to-JSONP auto-promotion // behavior is gone in jQuery 4.0 and as it has security implications, we don't @@ -40,7 +40,7 @@ if ( !jQueryVersionSince( "4.0.0" ) ) { .indexOf( "application/x-www-form-urlencoded" ) === 0 && rjsonp.test( s.data ) ) ) { - migrateWarn( "JSON-to-JSONP auto-promotion is deprecated" ); + migrateWarn( "jsonp-promotion", "JSON-to-JSONP auto-promotion is deprecated" ); } } ); } diff --git a/src/jquery/attributes.js b/src/jquery/attributes.js index 1efd9368..6228c163 100644 --- a/src/jquery/attributes.js +++ b/src/jquery/attributes.js @@ -1,30 +1,32 @@ -import { migrateWarn } from "../main.js"; +import { migratePatchFunc, migrateWarn } from "../main.js"; var oldRemoveAttr = jQuery.fn.removeAttr, oldToggleClass = jQuery.fn.toggleClass, rmatchNonSpace = /\S+/g; -jQuery.fn.removeAttr = function( name ) { +migratePatchFunc( jQuery.fn, "removeAttr", function( name ) { var self = this; jQuery.each( name.match( rmatchNonSpace ), function( _i, attr ) { if ( jQuery.expr.match.bool.test( attr ) ) { - migrateWarn( "jQuery.fn.removeAttr no longer sets boolean properties: " + attr ); + migrateWarn( "removeAttr-bool", + "jQuery.fn.removeAttr no longer sets boolean properties: " + attr ); self.prop( attr, false ); } } ); return oldRemoveAttr.apply( this, arguments ); -}; +}, "removeAttr-bool" ); -jQuery.fn.toggleClass = function( state ) { +migratePatchFunc( jQuery.fn, "toggleClass", function( state ) { // Only deprecating no-args or single boolean arg if ( state !== undefined && typeof state !== "boolean" ) { + return oldToggleClass.apply( this, arguments ); } - migrateWarn( "jQuery.fn.toggleClass( boolean ) is deprecated" ); + migrateWarn( "toggleClass-bool", "jQuery.fn.toggleClass( boolean ) is deprecated" ); // Toggle entire class name of each element return this.each( function() { @@ -46,4 +48,4 @@ jQuery.fn.toggleClass = function( state ) { ); } } ); -}; +}, "toggleClass-bool" ); diff --git a/src/jquery/core.js b/src/jquery/core.js index be411f54..e67b5782 100644 --- a/src/jquery/core.js +++ b/src/jquery/core.js @@ -1,5 +1,11 @@ import { jQueryVersionSince } from "../compareVersions.js"; -import { migrateWarn, migrateWarnFunc, migrateWarnProp } from "../main.js"; +import { + migratePatchFunc, + migrateWarn, + migratePatchAndWarnFunc, + migrateWarnProp +} from "../main.js"; +import "../disablePatches.js"; var findProp, class2type = {}, @@ -13,21 +19,27 @@ var findProp, // Make sure we trim BOM and NBSP rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g; -jQuery.fn.init = function( arg1 ) { +migratePatchFunc( jQuery.fn, "init", function( arg1 ) { var args = Array.prototype.slice.call( arguments ); - if ( typeof arg1 === "string" && arg1 === "#" ) { + if ( jQuery.migrateIsPatchEnabled( "selector-empty-id" ) && + typeof arg1 === "string" && arg1 === "#" ) { - // JQuery( "#" ) is a bogus ID selector, but it returned an empty set before jQuery 3.0 - migrateWarn( "jQuery( '#' ) is not a valid selector" ); + // JQuery( "#" ) is a bogus ID selector, but it returned an empty set + // before jQuery 3.0 + migrateWarn( "selector-empty-id", "jQuery( '#' ) is not a valid selector" ); args[ 0 ] = []; } return oldInit.apply( this, args ); -}; +}, "selector-empty-id" ); + +// This is already done in Core but the above patch will lose this assignment +// so we need to redo it. It doesn't matter whether the patch is enabled or not +// as the method is always going to be a Migrate-created wrapper. jQuery.fn.init.prototype = jQuery.fn; -jQuery.find = function( selector ) { +migratePatchFunc( jQuery, "find", function( selector ) { var args = Array.prototype.slice.call( arguments ); // Support: PhantomJS 1.x @@ -49,16 +61,18 @@ jQuery.find = function( selector ) { // Note that there may be false alarms if selector uses jQuery extensions try { window.document.querySelector( selector ); - migrateWarn( "Attribute selector with '#' must be quoted: " + args[ 0 ] ); + migrateWarn( "selector-hash", + "Attribute selector with '#' must be quoted: " + args[ 0 ] ); args[ 0 ] = selector; } catch ( err2 ) { - migrateWarn( "Attribute selector with '#' was not fixed: " + args[ 0 ] ); + migrateWarn( "selector-hash", + "Attribute selector with '#' was not fixed: " + args[ 0 ] ); } } } return oldFind.apply( this, args ); -}; +}, "selector-hash" ); // Copy properties attached to original jQuery.find method (e.g. .attr, .isXML) for ( findProp in oldFind ) { @@ -68,53 +82,53 @@ for ( findProp in oldFind ) { } // The number of elements contained in the matched element set -migrateWarnFunc( jQuery.fn, "size", function() { +migratePatchAndWarnFunc( jQuery.fn, "size", function() { return this.length; -}, +}, "size", "jQuery.fn.size() is deprecated and removed; use the .length property" ); -migrateWarnFunc( jQuery, "parseJSON", function() { +migratePatchAndWarnFunc( jQuery, "parseJSON", function() { return JSON.parse.apply( null, arguments ); -}, +}, "parseJSON", "jQuery.parseJSON is deprecated; use JSON.parse" ); -migrateWarnFunc( jQuery, "holdReady", jQuery.holdReady, - "jQuery.holdReady is deprecated" ); +migratePatchAndWarnFunc( jQuery, "holdReady", jQuery.holdReady, + "holdReady", "jQuery.holdReady is deprecated" ); -migrateWarnFunc( jQuery, "unique", jQuery.uniqueSort, - "jQuery.unique is deprecated; use jQuery.uniqueSort" ); +migratePatchAndWarnFunc( jQuery, "unique", jQuery.uniqueSort, + "unique", "jQuery.unique is deprecated; use jQuery.uniqueSort" ); // Now jQuery.expr.pseudos is the standard incantation -migrateWarnProp( jQuery.expr, "filters", jQuery.expr.pseudos, +migrateWarnProp( jQuery.expr, "filters", jQuery.expr.pseudos, "expr-pre-pseudos", "jQuery.expr.filters is deprecated; use jQuery.expr.pseudos" ); -migrateWarnProp( jQuery.expr, ":", jQuery.expr.pseudos, +migrateWarnProp( jQuery.expr, ":", jQuery.expr.pseudos, "expr-pre-pseudos", "jQuery.expr[':'] is deprecated; use jQuery.expr.pseudos" ); // Prior to jQuery 3.1.1 there were internal refs so we don't warn there if ( jQueryVersionSince( "3.1.1" ) ) { - migrateWarnFunc( jQuery, "trim", function( text ) { + migratePatchAndWarnFunc( jQuery, "trim", function( text ) { return text == null ? "" : ( text + "" ).replace( rtrim, "" ); - }, + }, "trim", "jQuery.trim is deprecated; use String.prototype.trim" ); } // Prior to jQuery 3.2 there were internal refs so we don't warn there if ( jQueryVersionSince( "3.2.0" ) ) { - migrateWarnFunc( jQuery, "nodeName", function( elem, name ) { + migratePatchAndWarnFunc( jQuery, "nodeName", function( elem, name ) { return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); - }, + }, "nodeName", "jQuery.nodeName is deprecated" ); - migrateWarnFunc( jQuery, "isArray", Array.isArray, + migratePatchAndWarnFunc( jQuery, "isArray", Array.isArray, "isArray", "jQuery.isArray is deprecated; use Array.isArray" ); } if ( jQueryVersionSince( "3.3.0" ) ) { - migrateWarnFunc( jQuery, "isNumeric", function( obj ) { + migratePatchAndWarnFunc( jQuery, "isNumeric", function( obj ) { // As of jQuery 3.0, isNumeric is limited to // strings and numbers (primitives or objects) @@ -126,7 +140,7 @@ if ( jQueryVersionSince( "3.3.0" ) ) { // ...but misinterprets leading-number strings, e.g. hex literals ("0x...") // subtraction forces infinities to NaN !isNaN( obj - parseFloat( obj ) ); - }, + }, "isNumeric", "jQuery.isNumeric() is deprecated" ); @@ -137,7 +151,7 @@ if ( jQueryVersionSince( "3.3.0" ) ) { class2type[ "[object " + name + "]" ] = name.toLowerCase(); } ); - migrateWarnFunc( jQuery, "type", function( obj ) { + migratePatchAndWarnFunc( jQuery, "type", function( obj ) { if ( obj == null ) { return obj + ""; } @@ -146,19 +160,19 @@ if ( jQueryVersionSince( "3.3.0" ) ) { return typeof obj === "object" || typeof obj === "function" ? class2type[ Object.prototype.toString.call( obj ) ] || "object" : typeof obj; - }, + }, "type", "jQuery.type is deprecated" ); - migrateWarnFunc( jQuery, "isFunction", + migratePatchAndWarnFunc( jQuery, "isFunction", function( obj ) { return typeof obj === "function"; - }, + }, "isFunction", "jQuery.isFunction() is deprecated" ); - migrateWarnFunc( jQuery, "isWindow", + migratePatchAndWarnFunc( jQuery, "isWindow", function( obj ) { return obj != null && obj === obj.window; - }, + }, "isWindow", "jQuery.isWindow() is deprecated" ); } diff --git a/src/jquery/css.js b/src/jquery/css.js index f04b3649..fadcb11d 100644 --- a/src/jquery/css.js +++ b/src/jquery/css.js @@ -1,8 +1,8 @@ import { jQueryVersionSince } from "../compareVersions.js"; -import { migrateWarn } from "../main.js"; +import { migrateWarn, migratePatchFunc } from "../main.js"; import { camelCase } from "../utils.js"; -var oldFnCss, +var origFnCss, internalSwapCall = false, ralphaStart = /^[a-z]/, @@ -47,12 +47,12 @@ if ( jQuery.swap ) { } ); } -jQuery.swap = function( elem, options, callback, args ) { +migratePatchFunc( jQuery, "swap", function( elem, options, callback, args ) { var ret, name, old = {}; if ( !internalSwapCall ) { - migrateWarn( "jQuery.swap() is undocumented and deprecated" ); + migrateWarn( "swap", "jQuery.swap() is undocumented and deprecated" ); } // Remember the old values, and insert the new ones @@ -69,13 +69,12 @@ jQuery.swap = function( elem, options, callback, args ) { } return ret; -}; +}, "swap" ); if ( jQueryVersionSince( "3.4.0" ) && typeof Proxy !== "undefined" ) { - jQuery.cssProps = new Proxy( jQuery.cssProps || {}, { set: function() { - migrateWarn( "jQuery.cssProps is deprecated" ); + migrateWarn( "cssProps", "jQuery.cssProps is deprecated" ); return Reflect.set.apply( this, arguments ); } } ); @@ -85,8 +84,8 @@ if ( jQueryVersionSince( "3.4.0" ) && typeof Proxy !== "undefined" ) { // https://github.com/jquery/jquery/blob/3.6.0/src/css.js#L212-L233 // This way, number values for the CSS properties below won't start triggering // Migrate warnings when jQuery gets updated to >=4.0.0 (gh-438). -if ( !jQuery.cssNumber ) { - jQuery.cssNumber = { +if ( jQueryVersionSince( "4.0.0" ) && typeof Proxy !== "undefined" ) { + jQuery.cssNumber = new Proxy( { animationIterationCount: true, columnCount: true, fillOpacity: true, @@ -107,7 +106,16 @@ if ( !jQuery.cssNumber ) { widows: true, zIndex: true, zoom: true - }; + }, { + get: function() { + migrateWarn( "css-number", "jQuery.cssNumber is deprecated" ); + return Reflect.get.apply( this, arguments ); + }, + set: function() { + migrateWarn( "css-number", "jQuery.cssNumber is deprecated" ); + return Reflect.set.apply( this, arguments ); + } + } ); } function isAutoPx( prop ) { @@ -119,24 +127,27 @@ function isAutoPx( prop ) { rautoPx.test( prop[ 0 ].toUpperCase() + prop.slice( 1 ) ); } -oldFnCss = jQuery.fn.css; +origFnCss = jQuery.fn.css; -jQuery.fn.css = function( name, value ) { +migratePatchFunc( jQuery.fn, "css", function( name, value ) { var camelName, origThis = this; + if ( name && typeof name === "object" && !Array.isArray( name ) ) { jQuery.each( name, function( n, v ) { jQuery.fn.css.call( origThis, n, v ); } ); return this; } + if ( typeof value === "number" ) { camelName = camelCase( name ); if ( !isAutoPx( camelName ) && !jQuery.cssNumber[ camelName ] ) { - migrateWarn( "Number-typed values are deprecated for jQuery.fn.css( \"" + + migrateWarn( "css-number", + "Number-typed values are deprecated for jQuery.fn.css( \"" + name + "\", value )" ); } } - return oldFnCss.apply( this, arguments ); -}; + return origFnCss.apply( this, arguments ); +}, "css-number" ); diff --git a/src/jquery/data.js b/src/jquery/data.js index 40e07d96..07430ce6 100644 --- a/src/jquery/data.js +++ b/src/jquery/data.js @@ -1,34 +1,38 @@ -import { migrateWarn } from "../main.js"; +import { migratePatchFunc, migrateWarn } from "../main.js"; import { camelCase } from "../utils.js"; -var oldData = jQuery.data; +var origData = jQuery.data; -jQuery.data = function( elem, name, value ) { +migratePatchFunc( jQuery, "data", function( elem, name, value ) { var curData, sameKeys, key; // Name can be an object, and each entry in the object is meant to be set as data if ( name && typeof name === "object" && arguments.length === 2 ) { - curData = jQuery.hasData( elem ) && oldData.call( this, elem ); + + curData = jQuery.hasData( elem ) && origData.call( this, elem ); sameKeys = {}; for ( key in name ) { if ( key !== camelCase( key ) ) { - migrateWarn( "jQuery.data() always sets/gets camelCased names: " + key ); + migrateWarn( "data-camelCase", + "jQuery.data() always sets/gets camelCased names: " + key ); curData[ key ] = name[ key ]; } else { sameKeys[ key ] = name[ key ]; } } - oldData.call( this, elem, sameKeys ); + origData.call( this, elem, sameKeys ); return name; } // If the name is transformed, look for the un-transformed name in the data object if ( name && typeof name === "string" && name !== camelCase( name ) ) { - curData = jQuery.hasData( elem ) && oldData.call( this, elem ); + + curData = jQuery.hasData( elem ) && origData.call( this, elem ); if ( curData && name in curData ) { - migrateWarn( "jQuery.data() always sets/gets camelCased names: " + name ); + migrateWarn( "data-camelCase", + "jQuery.data() always sets/gets camelCased names: " + name ); if ( arguments.length > 2 ) { curData[ name ] = value; } @@ -36,5 +40,5 @@ jQuery.data = function( elem, name, value ) { } } - return oldData.apply( this, arguments ); -}; + return origData.apply( this, arguments ); +}, "data-camelCase" ); diff --git a/src/jquery/deferred.js b/src/jquery/deferred.js index 7fe22907..30268adb 100644 --- a/src/jquery/deferred.js +++ b/src/jquery/deferred.js @@ -1,4 +1,4 @@ -import { migrateWarn } from "../main.js"; +import { migratePatchFunc, migratePatchAndWarnFunc } from "../main.js"; // Support jQuery slim which excludes the deferred module in jQuery 4.0+ if ( jQuery.Deferred ) { @@ -15,15 +15,13 @@ var oldDeferred = jQuery.Deferred, jQuery.Callbacks( "memory" ) ] ]; -jQuery.Deferred = function( func ) { +migratePatchFunc( jQuery, "Deferred", function( func ) { var deferred = oldDeferred(), promise = deferred.promise(); - deferred.pipe = promise.pipe = function( /* fnDone, fnFail, fnProgress */ ) { + function newDeferredPipe( /* fnDone, fnFail, fnProgress */ ) { var fns = arguments; - migrateWarn( "deferred.pipe() is deprecated" ); - return jQuery.Deferred( function( newDefer ) { jQuery.each( tuples, function( i, tuple ) { var fn = typeof fns[ i ] === "function" && fns[ i ]; @@ -48,15 +46,19 @@ jQuery.Deferred = function( func ) { } ); fns = null; } ).promise(); + } - }; + migratePatchAndWarnFunc( deferred, "pipe", newDeferredPipe, "deferred-pipe", + "deferred.pipe() is deprecated" ); + migratePatchAndWarnFunc( promise, "pipe", newDeferredPipe, "deferred-pipe", + "deferred.pipe() is deprecated" ); if ( func ) { func.call( deferred, deferred ); } return deferred; -}; +}, "deferred-pipe" ); // Preserve handler of uncaught exceptions in promise chains jQuery.Deferred.exceptionHook = oldDeferred.exceptionHook; diff --git a/src/jquery/effects.js b/src/jquery/effects.js index bb9f5b4c..ad4453aa 100644 --- a/src/jquery/effects.js +++ b/src/jquery/effects.js @@ -1,4 +1,5 @@ -import { migrateWarn } from "../main.js"; +import { migratePatchFunc, migrateWarn } from "../main.js"; +import "../disablePatches.js"; // Support jQuery slim which excludes the effects module if ( jQuery.fx ) { @@ -9,9 +10,10 @@ var intervalValue, intervalMsg, return pct; }; -jQuery.Tween.prototype.run = function( ) { +migratePatchFunc( jQuery.Tween.prototype, "run", function( ) { if ( jQuery.easing[ this.easing ].length > 1 ) { migrateWarn( + "easing-one-arg", "'jQuery.easing." + this.easing.toString() + "' should use only one argument" ); @@ -19,9 +21,9 @@ jQuery.Tween.prototype.run = function( ) { } oldTweenRun.apply( this, arguments ); -}; +}, "easing-one-arg" ); -intervalValue = jQuery.fx.interval || 13; +intervalValue = jQuery.fx.interval; intervalMsg = "jQuery.fx.interval is deprecated"; // Support: IE9, Android <=4.4 @@ -33,12 +35,17 @@ if ( window.requestAnimationFrame ) { enumerable: true, get: function() { if ( !window.document.hidden ) { - migrateWarn( intervalMsg ); + migrateWarn( "fx-interval", intervalMsg ); } - return intervalValue; + + // Only fallback to the default if patch is enabled + if ( !jQuery.migrateIsPatchEnabled( "fx-interval" ) ) { + return intervalValue; + } + return intervalValue === undefined ? 13 : intervalValue; }, set: function( newValue ) { - migrateWarn( intervalMsg ); + migrateWarn( "fx-interval", intervalMsg ); intervalValue = newValue; } } ); diff --git a/src/jquery/event.js b/src/jquery/event.js index e74d5949..395589f3 100644 --- a/src/jquery/event.js +++ b/src/jquery/event.js @@ -1,4 +1,10 @@ -import { migrateWarn, migrateWarnProp } from "../main.js"; +import { + migrateWarn, + migratePatchAndWarnFunc, + migratePatchFunc, + migrateWarnProp +} from "../main.js"; +import "../disablePatches.js"; var oldLoad = jQuery.fn.load, oldEventAdd = jQuery.event.add, @@ -8,16 +14,18 @@ jQuery.event.props = []; jQuery.event.fixHooks = {}; migrateWarnProp( jQuery.event.props, "concat", jQuery.event.props.concat, + "event-old-patch", "jQuery.event.props.concat() is deprecated and removed" ); -jQuery.event.fix = function( originalEvent ) { +migratePatchFunc( jQuery.event, "fix", function( originalEvent ) { var event, type = originalEvent.type, fixHook = this.fixHooks[ type ], props = jQuery.event.props; if ( props.length ) { - migrateWarn( "jQuery.event.props are deprecated and removed: " + props.join() ); + migrateWarn( "event-old-patch", + "jQuery.event.props are deprecated and removed: " + props.join() ); while ( props.length ) { jQuery.event.addProp( props.pop() ); } @@ -25,7 +33,8 @@ jQuery.event.fix = function( originalEvent ) { if ( fixHook && !fixHook._migrated_ ) { fixHook._migrated_ = true; - migrateWarn( "jQuery.event.fixHooks are deprecated and removed: " + type ); + migrateWarn( "event-old-patch", + "jQuery.event.fixHooks are deprecated and removed: " + type ); if ( ( props = fixHook.props ) && props.length ) { while ( props.length ) { jQuery.event.addProp( props.pop() ); @@ -35,21 +44,24 @@ jQuery.event.fix = function( originalEvent ) { event = originalFix.call( this, originalEvent ); - return fixHook && fixHook.filter ? fixHook.filter( event, originalEvent ) : event; -}; + return fixHook && fixHook.filter ? + fixHook.filter( event, originalEvent ) : + event; +}, "event-old-patch" ); -jQuery.event.add = function( elem, types ) { +migratePatchFunc( jQuery.event, "add", function( elem, types ) { // This misses the multiple-types case but that seems awfully rare if ( elem === window && types === "load" && window.document.readyState === "complete" ) { - migrateWarn( "jQuery(window).on('load'...) called after load event occurred" ); + migrateWarn( "load-after-event", + "jQuery(window).on('load'...) called after load event occurred" ); } return oldEventAdd.apply( this, arguments ); -}; +}, "load-after-event" ); jQuery.each( [ "load", "unload", "error" ], function( _, name ) { - jQuery.fn[ name ] = function() { + migratePatchFunc( jQuery.fn, name, function() { var args = Array.prototype.slice.call( arguments, 0 ); // If this is an ajax load() the first arg should be the string URL; @@ -60,7 +72,8 @@ jQuery.each( [ "load", "unload", "error" ], function( _, name ) { return oldLoad.apply( this, args ); } - migrateWarn( "jQuery.fn." + name + "() is deprecated" ); + migrateWarn( "shorthand-removed-v3", + "jQuery.fn." + name + "() is deprecated" ); args.splice( 0, 0, name ); if ( arguments.length ) { @@ -73,7 +86,7 @@ jQuery.each( [ "load", "unload", "error" ], function( _, name ) { // See http://bugs.jquery.com/ticket/11820 this.triggerHandler.apply( this, args ); return this; - }; + }, "shorthand-removed-v3" ); } ); @@ -83,12 +96,13 @@ jQuery.each( ( "blur focus focusin focusout resize scroll click dblclick " + function( _i, name ) { // Handle event binding - jQuery.fn[ name ] = function( data, fn ) { - migrateWarn( "jQuery.fn." + name + "() event shorthand is deprecated" ); + migratePatchAndWarnFunc( jQuery.fn, name, function( data, fn ) { return arguments.length > 0 ? this.on( name, null, data, fn ) : this.trigger( name ); - }; + }, + "shorthand-deprecated-v3", + "jQuery.fn." + name + "() event shorthand is deprecated" ); } ); // Trigger "ready" event only once, on document ready @@ -99,33 +113,25 @@ jQuery( function() { jQuery.event.special.ready = { setup: function() { if ( this === window.document ) { - migrateWarn( "'ready' event is deprecated" ); + migrateWarn( "ready-event", "'ready' event is deprecated" ); } } }; -jQuery.fn.extend( { - - bind: function( types, data, fn ) { - migrateWarn( "jQuery.fn.bind() is deprecated" ); - return this.on( types, null, data, fn ); - }, - unbind: function( types, fn ) { - migrateWarn( "jQuery.fn.unbind() is deprecated" ); - return this.off( types, null, fn ); - }, - delegate: function( selector, types, data, fn ) { - migrateWarn( "jQuery.fn.delegate() is deprecated" ); - return this.on( types, selector, data, fn ); - }, - undelegate: function( selector, types, fn ) { - migrateWarn( "jQuery.fn.undelegate() is deprecated" ); - return arguments.length === 1 ? - this.off( selector, "**" ) : - this.off( types, selector || "**", fn ); - }, - hover: function( fnOver, fnOut ) { - migrateWarn( "jQuery.fn.hover() is deprecated" ); - return this.on( "mouseenter", fnOver ).on( "mouseleave", fnOut || fnOver ); - } -} ); +migratePatchAndWarnFunc( jQuery.fn, "bind", function( types, data, fn ) { + return this.on( types, null, data, fn ); +}, "pre-on-methods", "jQuery.fn.bind() is deprecated" ); +migratePatchAndWarnFunc( jQuery.fn, "unbind", function( types, fn ) { + return this.off( types, null, fn ); +}, "pre-on-methods", "jQuery.fn.unbind() is deprecated" ); +migratePatchAndWarnFunc( jQuery.fn, "delegate", function( selector, types, data, fn ) { + return this.on( types, selector, data, fn ); +}, "pre-on-methods", "jQuery.fn.delegate() is deprecated" ); +migratePatchAndWarnFunc( jQuery.fn, "undelegate", function( selector, types, fn ) { + return arguments.length === 1 ? + this.off( selector, "**" ) : + this.off( types, selector || "**", fn ); +}, "pre-on-methods", "jQuery.fn.undelegate() is deprecated" ); +migratePatchAndWarnFunc( jQuery.fn, "hover", function( fnOver, fnOut ) { + return this.on( "mouseenter", fnOver ).on( "mouseleave", fnOut || fnOver ); +}, "pre-on-methods", "jQuery.fn.hover() is deprecated" ); diff --git a/src/jquery/manipulation.js b/src/jquery/manipulation.js index e925a8b1..fe0754da 100644 --- a/src/jquery/manipulation.js +++ b/src/jquery/manipulation.js @@ -1,7 +1,7 @@ -import { migrateWarn } from "../main.js"; +import { migratePatchFunc, migrateWarn } from "../main.js"; +import "../disablePatches.js"; var rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([a-z][^\/\0>\x20\t\r\n\f]*)[^>]*)\/>/gi, - origHtmlPrefilter = jQuery.htmlPrefilter, makeMarkup = function( html ) { var doc = window.document.implementation.createHTMLDocument( "" ); doc.body.innerHTML = html; @@ -10,18 +10,24 @@ var rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([a-z][^\/\ warnIfChanged = function( html ) { var changed = html.replace( rxhtmlTag, "<$1>" ); if ( changed !== html && makeMarkup( html ) !== makeMarkup( changed ) ) { - migrateWarn( "HTML tags must be properly nested and closed: " + html ); + migrateWarn( "self-closed-tags", + "HTML tags must be properly nested and closed: " + html ); } }; +/** + * Deprecated, please use `jQuery.migrateDisablePatches( "self-closed-tags" )` instead. + * @deprecated + */ jQuery.UNSAFE_restoreLegacyHtmlPrefilter = function() { - jQuery.htmlPrefilter = function( html ) { - warnIfChanged( html ); - return html.replace( rxhtmlTag, "<$1>" ); - }; + jQuery.migrateEnablePatches( "self-closed-tags" ); }; -jQuery.htmlPrefilter = function( html ) { +migratePatchFunc( jQuery, "htmlPrefilter", function( html ) { warnIfChanged( html ); - return origHtmlPrefilter( html ); -}; + return html.replace( rxhtmlTag, "<$1>" ); +}, "self-closed-tags" ); + +// This patch needs to be disabled by default as it re-introduces +// security issues (CVE-2020-11022, CVE-2020-11023). +jQuery.migrateDisablePatches( "self-closed-tags" ); diff --git a/src/jquery/offset.js b/src/jquery/offset.js index 9caeff99..a99bc6a4 100644 --- a/src/jquery/offset.js +++ b/src/jquery/offset.js @@ -1,14 +1,14 @@ -import { migrateWarn } from "../main.js"; +import { migrateWarn, migratePatchFunc } from "../main.js"; -var oldOffset = jQuery.fn.offset; +var origOffset = jQuery.fn.offset; -jQuery.fn.offset = function() { +migratePatchFunc( jQuery.fn, "offset", function() { var elem = this[ 0 ]; if ( elem && ( !elem.nodeType || !elem.getBoundingClientRect ) ) { - migrateWarn( "jQuery.fn.offset() requires a valid DOM element" ); + migrateWarn( "offset-valid-elem", "jQuery.fn.offset() requires a valid DOM element" ); return arguments.length ? this : undefined; } - return oldOffset.apply( this, arguments ); -}; + return origOffset.apply( this, arguments ); +}, "offset-valid-elem" ); diff --git a/src/jquery/serialize.js b/src/jquery/serialize.js index 6313f90f..c26e10ed 100644 --- a/src/jquery/serialize.js +++ b/src/jquery/serialize.js @@ -1,22 +1,24 @@ -import { migrateWarn } from "../main.js"; +import { migratePatchFunc, migrateWarn } from "../main.js"; +import "../disablePatches.js"; // Support jQuery slim which excludes the ajax module // The jQuery.param patch is about respecting `jQuery.ajaxSettings.traditional` // so it doesn't make sense for the slim build. if ( jQuery.ajax ) { -var oldParam = jQuery.param; +var origParam = jQuery.param; -jQuery.param = function( data, traditional ) { +migratePatchFunc( jQuery, "param", function( data, traditional ) { var ajaxTraditional = jQuery.ajaxSettings && jQuery.ajaxSettings.traditional; if ( traditional === undefined && ajaxTraditional ) { - migrateWarn( "jQuery.param() no longer uses jQuery.ajaxSettings.traditional" ); + migrateWarn( "param-ajax-traditional", + "jQuery.param() no longer uses jQuery.ajaxSettings.traditional" ); traditional = ajaxTraditional; } - return oldParam.call( this, data, traditional ); -}; + return origParam.call( this, data, traditional ); +}, "param-ajax-traditional" ); } diff --git a/src/jquery/traversing.js b/src/jquery/traversing.js index 9a3c5152..830226ae 100644 --- a/src/jquery/traversing.js +++ b/src/jquery/traversing.js @@ -1,8 +1,4 @@ -import { migrateWarn } from "../main.js"; +import { migratePatchAndWarnFunc } from "../main.js"; -var oldSelf = jQuery.fn.andSelf || jQuery.fn.addBack; - -jQuery.fn.andSelf = function() { - migrateWarn( "jQuery.fn.andSelf() is deprecated and removed, use jQuery.fn.addBack()" ); - return oldSelf.apply( this, arguments ); -}; +migratePatchAndWarnFunc( jQuery.fn, "andSelf", jQuery.fn.addBack, "andSelf", + "jQuery.fn.andSelf() is deprecated and removed, use jQuery.fn.addBack()" ); diff --git a/src/main.js b/src/main.js index fa773717..6312eb9c 100644 --- a/src/main.js +++ b/src/main.js @@ -1,4 +1,5 @@ import { jQueryVersionSince } from "./compareVersions.js"; +import "./disablePatches.js"; ( function() { @@ -24,7 +25,7 @@ import { jQueryVersionSince } from "./compareVersions.js"; } )(); -export var warnedAbout = {}; +var warnedAbout = {}; // By default each warning is only reported once. jQuery.migrateDeduplicateWarnings = true; @@ -43,11 +44,12 @@ jQuery.migrateReset = function() { jQuery.migrateWarnings.length = 0; }; -export function migrateWarn( msg ) { +export function migrateWarn( code, msg ) { var console = window.console; - if ( !jQuery.migrateDeduplicateWarnings || !warnedAbout[ msg ] ) { + if ( jQuery.migrateIsPatchEnabled( code ) && + ( !jQuery.migrateDeduplicateWarnings || !warnedAbout[ msg ] ) ) { warnedAbout[ msg ] = true; - jQuery.migrateWarnings.push( msg ); + jQuery.migrateWarnings.push( msg + " [" + code + "]" ); if ( console && console.warn && !jQuery.migrateMute ) { console.warn( "JQMIGRATE: " + msg ); if ( jQuery.migrateTrace && console.trace ) { @@ -57,30 +59,60 @@ export function migrateWarn( msg ) { } } -export function migrateWarnProp( obj, prop, value, msg ) { +export function migrateWarnProp( obj, prop, value, code, msg ) { Object.defineProperty( obj, prop, { configurable: true, enumerable: true, get: function() { - migrateWarn( msg ); + migrateWarn( code, msg ); return value; }, set: function( newValue ) { - migrateWarn( msg ); + migrateWarn( code, msg ); value = newValue; } } ); } -export function migrateWarnFunc( obj, prop, newFunc, msg ) { +function migrateWarnFuncInternal( obj, prop, newFunc, code, msg ) { + var finalFunc, + origFunc = obj[ prop ]; + obj[ prop ] = function() { - migrateWarn( msg ); - return newFunc.apply( this, arguments ); + + // If `msg` not provided, do not warn; more sophisticated warnings + // logic is most likely embedded in `newFunc`, in that case here + // we just care about the logic choosing the proper implementation + // based on whether the patch is disabled or not. + if ( msg ) { + migrateWarn( code, msg ); + } + + // Since patches can be disabled & enabled dynamically, we + // need to decide which implementation to run on each invocation. + finalFunc = jQuery.migrateIsPatchEnabled( code ) ? + newFunc : + + // The function may not have existed originally so we need a fallback. + ( origFunc || jQuery.noop ); + + return finalFunc.apply( this, arguments ); }; } +export function migratePatchAndWarnFunc( obj, prop, newFunc, code, msg ) { + if ( !msg ) { + throw new Error( "No warning message provided" ); + } + return migrateWarnFuncInternal( obj, prop, newFunc, code, msg ); +} + +export function migratePatchFunc( obj, prop, newFunc, code ) { + return migrateWarnFuncInternal( obj, prop, newFunc, code ); +} + if ( window.document.compatMode === "BackCompat" ) { - // JQuery has never supported or tested Quirks Mode - migrateWarn( "jQuery is not compatible with Quirks Mode" ); + // jQuery has never supported or tested Quirks Mode + migrateWarn( "quirks", "jQuery is not compatible with Quirks Mode" ); } diff --git a/test/core-jquery2.html b/test/data/core-jquery2.html similarity index 91% rename from test/core-jquery2.html rename to test/data/core-jquery2.html index dc3dd7f3..e1700555 100644 --- a/test/core-jquery2.html +++ b/test/data/core-jquery2.html @@ -5,7 +5,7 @@ jQuery Migrate old-jQuery initialization test - + + diff --git a/test/event-props-concat.html b/test/data/event-props-concat.html similarity index 100% rename from test/event-props-concat.html rename to test/data/event-props-concat.html diff --git a/test/event-props.html b/test/data/event-props.html similarity index 100% rename from test/event-props.html rename to test/data/event-props.html diff --git a/test/event-ready.html b/test/data/event-ready.html similarity index 100% rename from test/event-ready.html rename to test/data/event-ready.html diff --git a/test/iframeTest.js b/test/data/iframeTest.js similarity index 100% rename from test/iframeTest.js rename to test/data/iframeTest.js diff --git a/test/migrate.js b/test/data/test-utils.js similarity index 100% rename from test/migrate.js rename to test/data/test-utils.js diff --git a/test/testinit.js b/test/data/testinit.js similarity index 75% rename from test/testinit.js rename to test/data/testinit.js index f4107464..98b16895 100644 --- a/test/testinit.js +++ b/test/data/testinit.js @@ -14,7 +14,7 @@ TestManager = { lines = "", urlTag = this.projects[ projectName ].urlTag, matcher = new RegExp( "\\b" + urlTag + "=([^&]+)" ), - projectRoot = this.baseURL + ( isSelf ? ".." : "../../" + projectName ), + projectRoot = this.baseURL + ( isSelf ? "../.." : "../../../" + projectName ), version = ( matcher.exec( document.location.search ) || {} )[ 1 ] || defaultVersion; if ( window.__karma__ && isSelf ) { @@ -25,18 +25,19 @@ TestManager = { // Order is important file = [ "version", - "migrate", - "core", - "ajax", - "attributes", - "css", - "data", - "effects", - "event", - "offset", - "serialize", - "traversing", - "deferred" + "data/test-utils", + "unit/migrate", + "unit/jquery/core", + "unit/jquery/ajax", + "unit/jquery/attributes", + "unit/jquery/css", + "unit/jquery/data", + "unit/jquery/effects", + "unit/jquery/event", + "unit/jquery/offset", + "unit/jquery/serialize", + "unit/jquery/traversing", + "unit/jquery/deferred" ]; for ( i = 0; i < file.length; i++ ) { @@ -103,7 +104,7 @@ TestManager = { }; iframe = jQuery( "
" ) .css( { position: "absolute", width: "500px", left: "-600px" } ) - .append( jQuery( "