Deferred: Fill in & warn jQuery.Deferred.getStackHook

The API has been replaced by `jQuery.Deferred.getErrorHook`; the legacy
name will be removed in jQuery 4.0.0.

Fixes gh-483
Closes gh-528

Author: mgol

build/tasks/npmcopy.js

@@ -8,7 +8,10 @@ const files = {
 
 	"qunit/qunit.js": "qunit/qunit/qunit.js",
 	"qunit/qunit.css": "qunit/qunit/qunit.css",
-	"qunit/LICENSE.txt": "qunit/LICENSE.txt"
+	"qunit/LICENSE.txt": "qunit/LICENSE.txt",
+
+	"sinon/sinon.js": "sinon/pkg/sinon.js",
+	"sinon/LICENSE.txt": "sinon/LICENSE"
 };
 
 async function npmcopy() {

eslint.config.js

@@ -97,6 +97,7 @@ export default [
 				Symbol: false,
 				jQuery: false,
 				QUnit: false,
+				sinon: false,
 				url: false,
 				expectWarning: false,
 				expectNoWarning: false,

package-lock.json

@@ -57,6 +57,7 @@
 		"qunit": "2.21.0",
 		"rollup": "4.22.4",
 		"selenium-webdriver": "4.21.0",
+		"sinon": "9.2.4",
 		"uglify-js": "3.9.4",
 		"yargs": "17.7.2"
 	},

package.json

@@ -1,9 +1,15 @@
-import { migratePatchFunc, migratePatchAndWarnFunc } from "../main.js";
+import {
+	migratePatchFunc,
+	migratePatchAndWarnFunc,
+	migrateWarn
+} from "../main.js";
+import { jQueryVersionSince } from "../compareVersions.js";
 
 // Support jQuery slim which excludes the deferred module in jQuery 4.0+
 if ( jQuery.Deferred ) {
 
-var oldDeferred = jQuery.Deferred,
+var unpatchedGetStackHookValue,
+	oldDeferred = jQuery.Deferred,
 	tuples = [
 
 		// Action, add listener, callbacks, .then handlers, final state
@@ -63,4 +69,39 @@ migratePatchFunc( jQuery, "Deferred", function( func ) {
 // Preserve handler of uncaught exceptions in promise chains
 jQuery.Deferred.exceptionHook = oldDeferred.exceptionHook;
 
+// Preserve the optional hook to record the error, if defined
+jQuery.Deferred.getErrorHook = oldDeferred.getErrorHook;
+
+// We want to mirror jQuery.Deferred.getErrorHook here, so we cannot use
+// existing Migrate utils.
+Object.defineProperty( jQuery.Deferred, "getStackHook", {
+	configurable: true,
+	enumerable: true,
+	get: function() {
+		if ( jQuery.migrateIsPatchEnabled( "deferred-getStackHook" ) ) {
+
+			// jQuery 3.x checks `getStackHook` if `getErrorHook` missing;
+			// don't warn on the getter there.
+			if ( jQueryVersionSince( "4.0.0" ) ) {
+				migrateWarn( "deferred-getStackHook",
+					"jQuery.Deferred.getStackHook is deprecated; " +
+					"use jQuery.Deferred.getErrorHook" );
+			}
+			return jQuery.Deferred.getErrorHook;
+		} else {
+			return unpatchedGetStackHookValue;
+		}
+	},
+	set: function( newValue ) {
+		if ( jQuery.migrateIsPatchEnabled( "deferred-getStackHook" ) ) {
+			migrateWarn( "deferred-getStackHook",
+				"jQuery.Deferred.getStackHook is deprecated; " +
+					"use jQuery.Deferred.getErrorHook" );
+			jQuery.Deferred.getErrorHook = newValue;
+		} else {
+			unpatchedGetStackHookValue = newValue;
+		}
+	}
+} );
+
 }

src/jquery/deferred.js

@@ -10,6 +10,7 @@
 	<!-- QUnit -->
 	<link rel="stylesheet" href="../external/qunit/qunit.css" media="screen">
 	<script src="../external/qunit/qunit.js"></script>
+	<script src="../external/sinon/sinon.js"></script>
 
 	<!-- A promise polyfill -->
 	<script src="../external/npo/npo.js"></script>