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.

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

Jump to bottom

Fix bad message handling #98

Merged
merged 2 commits into from
Apr 26, 2023
Merged

Fix bad message handling #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
51193bd
Remove caching of message in client class
jbrowneuk Apr 23, 2023
0804117
Fix build error caused by inclusion of Jest config
jbrowneuk Apr 23, 2023
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
74 changes: 35 additions & 39 deletions src/client/discord-client.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,86 +180,82 @@ describe('Discord client wrapper', () => {
});

describe('message sending', () => {
const mockUserName = 'bob-bobertson';

let mockMessage: IMock<discord.Message>;
let mockChannel: IMock<discord.TextChannel>;
let mockAuthor: IMock<discord.User>;

beforeEach(() => {
mockChannel = Mock.ofType();

mockAuthor = Mock.ofType();
mockAuthor.setup(a => a.username).returns(() => mockUserName);

mockMessage = Mock.ofType();
mockMessage.setup(m => m.channel).returns(() => mockChannel.object);
mockMessage.setup(s => s.author).returns(() => mockAuthor.object);
});

it('should queue messages', () => {
jest.spyOn(untypedClient, 'sendMessage').mockImplementation(() => {});

const messages = ['one', 'two', 'three'];
client.queueMessages(messages);
client.queueMessages(mockMessage.object, messages);

expect(untypedClient.sendMessage).toHaveBeenCalledTimes(messages.length);
});

it('should send queued messages', () => {
let sendCount = 0;
const mockChannel = {
send: () => {
sendCount += 1;
}
};
untypedClient.lastMessage = { channel: mockChannel };
mockChannel.setup(c => c.send(It.isAny())).callback(() => (sendCount += 1));

const messages = ['one', 'two', 'three'];
client.queueMessages(messages);
client.queueMessages(mockMessage.object, messages);

expect(sendCount).toBe(3);
expect(sendCount).toBe(messages.length);
});

it('should replace user string with last message user name if message is string', () => {
const expectedName = 'bob-bobertson';
let lastMessage = '';
const mockChannel = {
send: (message: string) => (lastMessage = message)
};
untypedClient.lastMessage = {
channel: mockChannel,
author: { username: expectedName }
};

mockChannel.setup(c => c.send(It.isAny())).callback(message => (lastMessage = message));

const messages = ['{£user} {£user} {£user}'];
client.queueMessages(messages);
client.queueMessages(mockMessage.object, messages);

expect(lastMessage).toBe(`${expectedName} ${expectedName} ${expectedName}`);
expect(lastMessage).toBe(`${mockUserName} ${mockUserName} ${mockUserName}`);
});

it('should replace name string with bot user name if message is string', () => {
let lastMessage = '';
const mockChannel = {
send: (message: string) => (lastMessage = message)
};
untypedClient.lastMessage = { channel: mockChannel };

mockChannel.setup(c => c.send(It.isAny())).callback(message => (lastMessage = message));

const messages = ['{£me}'];
client.queueMessages(messages);
client.queueMessages(mockMessage.object, messages);

expect(lastMessage).toBe(MOCK_BOT_USERNAME);
});

it('should replace user string with last message user name in content if message is MessageOptions', () => {
const expectedName = 'bob-bobertson';
let lastMessage: string | null | undefined = null;
const mockChannel = {
send: (message: discord.MessageOptions) => (lastMessage = message.content)
};
untypedClient.lastMessage = {
channel: mockChannel,
author: { username: expectedName }
};

mockChannel.setup(c => c.send(It.isAny())).callback(message => (lastMessage = message.content));

const messageOptions = { content: '{£user} {£user} {£user}' };
client.queueMessages([messageOptions]);
client.queueMessages(mockMessage.object, [messageOptions]);

expect(lastMessage).toBe(`${expectedName} ${expectedName} ${expectedName}`);
expect(lastMessage).toBe(`${mockUserName} ${mockUserName} ${mockUserName}`);
});

it('should replace name string with bot user name in content if message is MessageOptions', () => {
let lastMessage: string | null | undefined = null;
const mockChannel = {
send: (message: discord.MessageOptions) => (lastMessage = message.content)
};
untypedClient.lastMessage = { channel: mockChannel };

mockChannel.setup(c => c.send(It.isAny())).callback(message => (lastMessage = message.content));

const messageOptions = { content: '{£me}' };
client.queueMessages([messageOptions]);
client.queueMessages(mockMessage.object, [messageOptions]);

expect(lastMessage).toBe(MOCK_BOT_USERNAME);
});
Expand Down
21 changes: 9 additions & 12 deletions src/client/discord-client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,12 @@ import { messageEvent, readyEvent } from './discord-events';

export class DiscordClient extends EventEmitter implements Client {
private client: DiscordApiClient;
private lastMessage: Message;
private connected: boolean;

constructor(private logger: Logger) {
super();

this.client = null;
this.lastMessage = null;
this.connected = false;
}

Expand Down Expand Up @@ -49,8 +47,8 @@ export class DiscordClient extends EventEmitter implements Client {
return this.client.user;
}

public queueMessages(messages: MessageType[]): void {
messages.forEach((message: MessageType) => this.sendMessage(message));
public queueMessages(source: Message, messages: MessageType[]): void {
messages.forEach((message: MessageType) => this.sendMessage(source, message));
}

public setPresence(data: PresenceData): void {
Expand All @@ -75,21 +73,20 @@ export class DiscordClient extends EventEmitter implements Client {
return;
}

this.lastMessage = message;
this.emit(LifecycleEvents.MESSAGE, message);
}

private performTextExpansion(input: string): string {
if (this.lastMessage.author) {
input = input.replace(/\{£user\}/g, this.lastMessage.author.username);
private performTextExpansion(source: Message, input: string): string {
if (source.author) {
input = input.replace(/\{£user\}/g, source.author.username);
}

input = input.replace(/\{£me\}/g, this.client.user.username);

return input;
}

private sendMessage(message: MessageType): void {
private sendMessage(source: Message, message: MessageType): void {
if (!message) {
return;
}
Expand All @@ -100,7 +97,7 @@ export class DiscordClient extends EventEmitter implements Client {
return;
}

this.lastMessage.channel.send(this.performTextExpansion(message));
source.channel.send(this.performTextExpansion(source, message));
return;
}

Expand All @@ -115,9 +112,9 @@ export class DiscordClient extends EventEmitter implements Client {
}

if (messageOptions.content) {
messageOptions.content = this.performTextExpansion(messageOptions.content);
messageOptions.content = this.performTextExpansion(source, messageOptions.content);
}

this.lastMessage.channel.send(messageOptions);
source.channel.send(messageOptions);
}
}
Loading