gnome-shell/tests/unit/signalTracker.js
Florian Müllner cf29ec2f22 signalTracker: Add TransientSignalHolder class
There are cases where we want to connect to a number of signals
for the lifetime of an object, but also other signals for a
limited period (say: between show and hide).

It is currently not possible to use disconnectObject() for the
latter, because it will disconnect all signals.

To address this use case, add a small class that can be used as
a transient signal holder, while still benefiting from autocleanup
by proxying the real owner.

Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/2221>
2022-03-05 00:12:27 +00:00

118 lines
2.6 KiB
JavaScript

// -*- mode: js; js-indent-level: 4; indent-tabs-mode: nil -*-
// Test cases for version comparison
const { GObject } = imports.gi;
const JsUnit = imports.jsUnit;
const Signals = imports.signals;
const Environment = imports.ui.environment;
const { TransientSignalHolder } = imports.misc.signalTracker;
Environment.init();
const Destroyable = GObject.registerClass({
Signals: { 'destroy': {} },
}, class Destroyable extends GObject.Object {});
class PlainEmitter {}
Signals.addSignalMethods(PlainEmitter.prototype);
const GObjectEmitter = GObject.registerClass({
Signals: { 'signal': {} },
}, class GObjectEmitter extends Destroyable {});
const emitter1 = new PlainEmitter();
const emitter2 = new GObjectEmitter();
const tracked1 = new Destroyable();
const tracked2 = {};
let count = 0;
const handler = () => count++;
emitter1.connectObject('signal', handler, tracked1);
emitter2.connectObject('signal', handler, tracked1);
emitter1.connectObject('signal', handler, tracked2);
emitter2.connectObject('signal', handler, tracked2);
JsUnit.assertEquals(count, 0);
emitter1.emit('signal');
emitter2.emit('signal');
JsUnit.assertEquals(count, 4);
tracked1.emit('destroy');
emitter1.emit('signal');
emitter2.emit('signal');
JsUnit.assertEquals(count, 6);
emitter1.disconnectObject(tracked2);
emitter2.emit('destroy');
emitter1.emit('signal');
emitter2.emit('signal');
JsUnit.assertEquals(count, 6);
emitter1.connectObject(
'signal', handler,
'signal', handler, GObject.ConnectFlags.AFTER,
tracked1);
emitter2.connectObject(
'signal', handler,
'signal', handler, GObject.ConnectFlags.AFTER,
tracked1);
emitter1.emit('signal');
emitter2.emit('signal');
JsUnit.assertEquals(count, 10);
tracked1.emit('destroy');
emitter1.emit('signal');
emitter2.emit('signal');
JsUnit.assertEquals(count, 10);
emitter1.connectObject('signal', handler, tracked1);
emitter2.connectObject('signal', handler, tracked1);
transientHolder = new TransientSignalHolder(tracked1);
emitter1.connectObject('signal', handler, transientHolder);
emitter2.connectObject('signal', handler, transientHolder);
emitter1.emit('signal');
emitter2.emit('signal');
JsUnit.assertEquals(count, 14);
transientHolder.destroy();
emitter1.emit('signal');
emitter2.emit('signal');
JsUnit.assertEquals(count, 16);
transientHolder = new TransientSignalHolder(tracked1);
emitter1.connectObject('signal', handler, transientHolder);
emitter2.connectObject('signal', handler, transientHolder);
emitter1.emit('signal');
emitter2.emit('signal');
JsUnit.assertEquals(count, 20);
tracked1.emit('destroy');
emitter1.emit('signal');
emitter2.emit('signal');
JsUnit.assertEquals(count, 20);