Skip to content

feat: add self flag to message events for echo-message and znc.in/self-message #412

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.

Sign up for GitHub

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

Open
ValwareIRC wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: add self flag to message events for echo-message and znc.in/self-message #412

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 20 additions & 4 deletions src/commands/handlers/messaging.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,18 @@ const _ = {
};
const util = require('util');

// Returns true when the message was sent by our own client and echoed back by the server.
// This happens when either echo-message or znc.in/self-message cap is active.
function isSelfMessage(command, handler) {
const cap = handler.network.cap;
const echoActive = cap.isEnabled('echo-message') || cap.isEnabled('znc.in/self-message');
if (!echoActive) {
return false;
}
const ownNick = handler.client.user.nick;
return !!(ownNick && command.nick && handler.client.caseCompare(command.nick, ownNick));
}

const handlers = {
NOTICE: function(command, handler) {
const time = command.getServerTime();
Expand Down Expand Up @@ -44,7 +56,8 @@ const handlers = {
tags: command.tags,
time: time,
account: command.getTag('account'),
batch: command.batch
batch: command.batch,
self: isSelfMessage(command, handler)
});
}
},
Expand Down Expand Up @@ -76,7 +89,8 @@ const handlers = {
tags: command.tags,
time: time,
account: command.getTag('account'),
batch: command.batch
batch: command.batch,
self: isSelfMessage(command, handler)
});
} else if (ctcp_command === 'VERSION' && handler.connection.options.version) {
handler.connection.write(util.format(
Expand Down Expand Up @@ -111,7 +125,8 @@ const handlers = {
tags: command.tags,
time: time,
account: command.getTag('account'),
batch: command.batch
batch: command.batch,
self: isSelfMessage(command, handler)
});
}
},
Expand All @@ -127,7 +142,8 @@ const handlers = {
tags: command.tags,
time: time,
account: command.getTag('account'),
batch: command.batch
batch: command.batch,
self: isSelfMessage(command, handler)
});
},

Expand Down
202 changes: 202 additions & 0 deletions test/commands/handlers/messaging.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@
'use strict';

/* globals describe, it */
const chai = require('chai');
const expect = chai.expect;
const sinon = require('sinon');
const sinonChai = require('sinon-chai');
const messaging = require('../../../src/commands/handlers/messaging');
const IrcCommand = require('../../../src/commands/command');

chai.use(sinonChai);

function makeHandler(opts) {
opts = opts || {};
const ownNick = opts.ownNick || 'testnick';
const enabledCaps = opts.enabledCaps || [];

const handlers = {};
messaging({
addHandler: function(command, handler) {
handlers[command] = handler;
}
});

const spies = {
emit: sinon.stub(),
connection: {
write: sinon.stub(),
options: { version: null }
},
network: {
addServerTimeOffset: sinon.stub(),
extractTargetGroup: sinon.stub().returns(null),
cap: {
isEnabled: function(cap) {
return enabledCaps.indexOf(cap) > -1;
}
}
},
client: {
user: { nick: ownNick },
caseCompare: function(a, b) {
return a.toLowerCase() === b.toLowerCase();
}
}
};

return { handlers, spies };
}

describe('src/commands/handlers/messaging.js', function() {
describe('PRIVMSG self flag', function() {
it('sets self=false when echo-message cap is not active', function() {
const { handlers, spies } = makeHandler({ ownNick: 'testnick', enabledCaps: [] });
const cmd = new IrcCommand('PRIVMSG', {
nick: 'testnick',
ident: 'user',
hostname: 'host',
params: ['#channel', 'hello world'],
tags: {}
});
handlers.PRIVMSG(cmd, spies);
expect(spies.emit).to.have.been.calledWith('privmsg', sinon.match({ self: false }));
});

it('sets self=true when echo-message cap is active and nick matches', function() {
const { handlers, spies } = makeHandler({ ownNick: 'testnick', enabledCaps: ['echo-message'] });
const cmd = new IrcCommand('PRIVMSG', {
nick: 'testnick',
ident: 'user',
hostname: 'host',
params: ['#channel', 'hello world'],
tags: {}
});
handlers.PRIVMSG(cmd, spies);
expect(spies.emit).to.have.been.calledWith('privmsg', sinon.match({ self: true }));
});

it('sets self=false when echo-message is active but nick differs', function() {
const { handlers, spies } = makeHandler({ ownNick: 'testnick', enabledCaps: ['echo-message'] });
const cmd = new IrcCommand('PRIVMSG', {
nick: 'othernick',
ident: 'user',
hostname: 'host',
params: ['#channel', 'hello world'],
tags: {}
});
handlers.PRIVMSG(cmd, spies);
expect(spies.emit).to.have.been.calledWith('privmsg', sinon.match({ self: false }));
});

it('sets self=true when znc.in/self-message cap is active and nick matches', function() {
const { handlers, spies } = makeHandler({ ownNick: 'testnick', enabledCaps: ['znc.in/self-message'] });
const cmd = new IrcCommand('PRIVMSG', {
nick: 'testnick',
ident: 'user',
hostname: 'host',
params: ['#channel', 'hello from znc'],
tags: {}
});
handlers.PRIVMSG(cmd, spies);
expect(spies.emit).to.have.been.calledWith('privmsg', sinon.match({ self: true }));
});

it('is case-insensitive for nick comparison', function() {
const { handlers, spies } = makeHandler({ ownNick: 'TestNick', enabledCaps: ['echo-message'] });
const cmd = new IrcCommand('PRIVMSG', {
nick: 'testnick',
ident: 'user',
hostname: 'host',
params: ['#channel', 'hello'],
tags: {}
});
handlers.PRIVMSG(cmd, spies);
expect(spies.emit).to.have.been.calledWith('privmsg', sinon.match({ self: true }));
});
});

describe('NOTICE self flag', function() {
it('sets self=false when echo-message cap is not active', function() {
const { handlers, spies } = makeHandler({ ownNick: 'testnick', enabledCaps: [] });
const cmd = new IrcCommand('NOTICE', {
nick: 'testnick',
ident: 'user',
hostname: 'host',
params: ['#channel', 'a notice'],
tags: {}
});
handlers.NOTICE(cmd, spies);
expect(spies.emit).to.have.been.calledWith('notice', sinon.match({ self: false }));
});

it('sets self=true when echo-message cap is active and nick matches', function() {
const { handlers, spies } = makeHandler({ ownNick: 'testnick', enabledCaps: ['echo-message'] });
const cmd = new IrcCommand('NOTICE', {
nick: 'testnick',
ident: 'user',
hostname: 'host',
params: ['#channel', 'a notice'],
tags: {}
});
handlers.NOTICE(cmd, spies);
expect(spies.emit).to.have.been.calledWith('notice', sinon.match({ self: true }));
});
});

describe('TAGMSG self flag', function() {
it('sets self=false when echo-message cap is not active', function() {
const { handlers, spies } = makeHandler({ ownNick: 'testnick', enabledCaps: [] });
const cmd = new IrcCommand('TAGMSG', {
nick: 'testnick',
ident: 'user',
hostname: 'host',
params: ['#channel'],
tags: { '+example': 'value' }
});
handlers.TAGMSG(cmd, spies);
expect(spies.emit).to.have.been.calledWith('tagmsg', sinon.match({ self: false }));
});

it('sets self=true when echo-message cap is active and nick matches', function() {
const { handlers, spies } = makeHandler({ ownNick: 'testnick', enabledCaps: ['echo-message'] });
const cmd = new IrcCommand('TAGMSG', {
nick: 'testnick',
ident: 'user',
hostname: 'host',
params: ['#channel'],
tags: { '+example': 'value' }
});
handlers.TAGMSG(cmd, spies);
expect(spies.emit).to.have.been.calledWith('tagmsg', sinon.match({ self: true }));
});
});

describe('ACTION (CTCP) self flag', function() {
it('sets self=false when echo-message cap is not active', function() {
const { handlers, spies } = makeHandler({ ownNick: 'testnick', enabledCaps: [] });
const cmd = new IrcCommand('PRIVMSG', {
nick: 'testnick',
ident: 'user',
hostname: 'host',
params: ['#channel', '\x01ACTION waves\x01'],
tags: {}
});
handlers.PRIVMSG(cmd, spies);
expect(spies.emit).to.have.been.calledWith('action', sinon.match({ self: false }));
});

it('sets self=true when echo-message cap is active and nick matches', function() {
const { handlers, spies } = makeHandler({ ownNick: 'testnick', enabledCaps: ['echo-message'] });
const cmd = new IrcCommand('PRIVMSG', {
nick: 'testnick',
ident: 'user',
hostname: 'host',
params: ['#channel', '\x01ACTION waves\x01'],
tags: {}
});
handlers.PRIVMSG(cmd, spies);
expect(spies.emit).to.have.been.calledWith('action', sinon.match({ self: true }));
});
});
});