v1.3.6.0: Allow OVERRIDE to chain

Fixes #28

Author: ruipin

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.3.6.0 (2021-04-09)
+
+* Allow OVERRIDE wrappers to continue chain if they pass `{chain: true}` as a fourth parameter to `libWrapper.register`.
+
 # 1.3.5.0 (2021-01-11)
 
 * Bugfix: Refactor usage of the handler objects (used to bootstrap a libWrapper call) so that dispatch is dynamic. Prevents references to wrapped methods from skipping the wrappers.

module.json

@@ -2,7 +2,7 @@
 	"name": "lib-wrapper",
 	"title": "libWrapper",
 	"description": "Library for wrapping core Foundry VTT methods, meant to improve compatibility between modules that wrap the same methods.",
-	"version": "1.3.5.0",
+	"version": "1.3.6.0",
 	"author": "Rui Pinheiro",
 	"esmodules": ["src/index.js"],
 	"styles": ["dist/lib-wrapper.css"],

src/lib/lib-wrapper.js

@@ -252,7 +252,7 @@ export class libWrapper {
 	 *
 	 *
 	 */
-	static register(module, target, fn, type='MIXED') {
+	static register(module, target, fn, type='MIXED', {chain=undefined}={}) {
 		// Validate module
 		this._validate_module(module);
 
@@ -271,6 +271,10 @@ export class libWrapper {
 		if(typeof type === 'undefined' || !(type in TYPES_REVERSE))
 			throw new LibWrapperModuleError(`Parameter 'type' must be one of [${TYPES_LIST.join(', ')}].`, module);
 
+		chain = chain ?? (type < TYPES.OVERRIDE);
+		if(typeof chain !== 'boolean')
+			throw new LibWrapperModuleError(`Parameter 'chain' must be a boolean.`, module);
+
 		// Split '#set' from the target
 		const target_and_setter  = this._split_target_and_setter(target);
 		const target_without_set = target_and_setter[0];
@@ -291,7 +295,7 @@ export class libWrapper {
 		const priority = this._get_default_priority(module, target);
 
 		// Only allow one 'OVERRIDE' type
-		if(type == TYPES.OVERRIDE) {
+		if(type >= TYPES.OVERRIDE) {
 			const existing = wrapper.get_fn_data(is_setter).find((x) => { return x.type == TYPES.OVERRIDE });
 
 			if(existing) {
@@ -319,7 +323,8 @@ export class libWrapper {
 			fn      : fn,
 			type    : type,
 			wrapper : wrapper,
-			priority: priority
+			priority: priority,
+			chain   : chain
 		};
 
 		wrapper.add(data);

src/lib/wrapper.js

@@ -392,8 +392,8 @@ export class Wrapper {
 		// Grab wrapper function from function data object
 		const fn = data.fn;
 
-		// OVERRIDE type does not continue the chain
-		if(data.type >= TYPES.OVERRIDE) {
+		// OVERRIDE type will usually not continue the chain
+		if(!data.chain) {//data.type >= TYPES.OVERRIDE) {
 			// Call next method in the chain
 			return fn.apply(obj, args);
 		}

tests/test_lib.js

@@ -104,6 +104,15 @@ test_sync_async('Library: Main', async function (t) {
 	libWrapper.register('m1', 'A.prototype.x', chkr.gen_wr('m1:Mix:7'));
 	await chkr.call(a, 'x', ['m1:Mix:7','Orig',-2]);
 
+	// Register an OVERRIDE with chain=true
+	game.add_module('m3');
+	libWrapper.register('m3', 'A.prototype.x', chkr.gen_wr('m3:Ovr:8'), 'OVERRIDE', {chain: true});
+	await chkr.call(a, 'x', ['m1:Mix:7','m3:Ovr:8','Orig',-3]);
+
+	// Unregister OVERRIDE
+	libWrapper.unregister('m3', 'A.prototype.x');
+	await chkr.call(a, 'x', ['m1:Mix:7','Orig',-2]);
+
 	// Test manual wrapping
 	A.prototype.x = (function() {
 		const wrapped = A.prototype.x;

tests/utilities.js

@@ -75,8 +75,6 @@ class Game {
 		this.add_module('lib-wrapper');
 	}
 }
-
-
 globalThis.game = new Game();
 globalThis.game.clear_modules();
 
@@ -100,15 +98,22 @@ class UiNotifications {
 globalThis.ui = { notifications: new UiNotifications() };
 
 
+// Dialog
+class Dialog {
+	render() {}
+}
+globalThis.Dialog = Dialog;
+
 
 
 // Wrap helpers to bypass libWrapper public API
-export const wrap_front = function(obj, fn_name, fn, is_setter=false) {
+export const wrap_front = function(obj, fn_name, fn, is_setter=false, chain=true) {
 	const wrapper = libWrapper._create_wrapper_from_object(obj, fn_name);
 	wrapper.get_fn_data(is_setter).splice(0, 0, {
 		fn: fn,
 		priority: undefined,
-		active: true
+		active: true,
+		chain: chain
 	});
 };