Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cordova events singleton object #60

Merged
merged 2 commits into from
Dec 20, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 51 additions & 42 deletions src/events.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,56 +17,65 @@
under the License.
*/

var EventEmitter = require('events').EventEmitter;
const EventEmitter = require('events').EventEmitter;

var INSTANCE = new EventEmitter();
INSTANCE.setMaxListeners(20);
var EVENTS_RECEIVER;
const MAX_LISTENERS = 20;

module.exports = INSTANCE;
const INSTANCE_KEY = Symbol.for('org.apache.cordova.common.CordovaEvents');

/**
* Sets up current instance to forward emitted events to another EventEmitter
* instance.
*
* @param {EventEmitter} [eventEmitter] The emitter instance to forward
* events to. Falsy value, when passed, disables forwarding.
*/
module.exports.forwardEventsTo = function (eventEmitter) {
let EVENTS_RECEIVER = null;

// If no argument is specified disable events forwarding
if (!eventEmitter) {
EVENTS_RECEIVER = undefined;
return;
}
class CordovaEventEmitter extends EventEmitter {
/**
* Sets up current instance to forward emitted events to another EventEmitter
* instance.
*
* @param {EventEmitter} [eventEmitter] The emitter instance to forward
* events to. Falsy value, when passed, disables forwarding.
*/
forwardEventsTo (eventEmitter) {
// If no argument is specified disable events forwarding
if (!eventEmitter) {
EVENTS_RECEIVER = undefined;
return;
}

if (!(eventEmitter instanceof EventEmitter)) { throw new Error('Cordova events can be redirected to another EventEmitter instance only'); }
if (!(eventEmitter instanceof EventEmitter)) {
throw new Error('Cordova events can be redirected to another EventEmitter instance only');
}

// CB-10940 Skipping forwarding to self to avoid infinite recursion.
// This is the case when the modules are npm-linked.
if (this !== eventEmitter) {
EVENTS_RECEIVER = eventEmitter;
} else {
// Reset forwarding if we are subscribing to self
EVENTS_RECEIVER = undefined;
// CB-10940 Skipping forwarding to self to avoid infinite recursion.
// This is the case when the modules are npm-linked.
if (this !== eventEmitter) {
EVENTS_RECEIVER = eventEmitter;
} else {
// Reset forwarding if we are subscribing to self
EVENTS_RECEIVER = undefined;
}
}
};

var emit = INSTANCE.emit;

/**
* This method replaces original 'emit' method to allow events forwarding.
*
* @return {eventEmitter} Current instance to allow calls chaining, as
* original 'emit' does
*/
module.exports.emit = function () {

var args = Array.prototype.slice.call(arguments);
/**
* Sets up current instance to forward emitted events to another EventEmitter
* instance.
*
* @param {EventEmitter} [eventEmitter] The emitter instance to forward
* events to. Falsy value, when passed, disables forwarding.
*/
emit (eventName, ...args) {
if (EVENTS_RECEIVER) {
EVENTS_RECEIVER.emit(eventName, ...args);
}

if (EVENTS_RECEIVER) {
EVENTS_RECEIVER.emit.apply(EVENTS_RECEIVER, args);
return super.emit(eventName, ...args);
}
}

// This singleton instance pattern is based on the ideas from
// https://derickbailey.com/2016/03/09/creating-a-true-singleton-in-node-js-with-es6-symbols/
if (Object.getOwnPropertySymbols(global).indexOf(INSTANCE_KEY) === -1) {
const events = new CordovaEventEmitter();
events.setMaxListeners(MAX_LISTENERS);
global[INSTANCE_KEY] = events;
}

return emit.apply(this, args);
};
module.exports = global[INSTANCE_KEY];