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

Add Discord Announcement channels to allowed bridging types #889

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
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
2 changes: 2 additions & 0 deletions changelog.d/889.bugfix
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
It is now possible to bridge a matrix channel with a Discord Announcement/News
channel. Contributed by @frostyfrog.
2 changes: 1 addition & 1 deletion src/bot.ts
Original file line number Diff line number Diff line change
Expand Up @@ -471,7 +471,7 @@ export class DiscordBot {
throw new Error(`Guild "${server}" not found`);
}
const channel = guild.channels.resolve(room);
if (channel && channel.type === "text") {
if (channel && ["text", "news"].includes(channel.type)) {
if (hasSender) {
const permissions = guild.me && channel.permissionsFor(guild.me);
if (!permissions || !permissions.has("VIEW_CHANNEL") || !permissions.has("SEND_MESSAGES")) {
Expand Down
15 changes: 14 additions & 1 deletion test/mocks/channel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ limitations under the License.

import {MockMember} from "./member";
import {MockCollection} from "./collection";
import {Permissions, PermissionResolvable, TextChannel} from "better-discord.js";
import {Permissions, PermissionResolvable, TextChannel, NewsChannel} from "better-discord.js";
import { MockGuild } from "./guild";

// we are a test file and thus need those
Expand Down Expand Up @@ -54,3 +54,16 @@ export class MockTextChannel extends TextChannel {
} as any, channelData);
}
}

export class MockNewsChannel extends NewsChannel {
constructor(guild?: MockGuild, channelData: any = {}) {
// Mock the nessacery
super(guild || {
client: {
options: {
messageCacheMaxSize: -1,
},
},
} as any, channelData);
}
}
4 changes: 2 additions & 2 deletions test/mocks/message.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ export class MockMessage {
public attachments = new MockCollection<string, any>();
public embeds: any[] = [];
public content = "";
public channel: Discord.TextChannel | undefined;
public channel: Discord.TextChannel | Discord.NewsChannel | undefined;
public guild: Discord.Guild | undefined;
public author: MockUser;
public mentions: any = {};
constructor(channel?: Discord.TextChannel) {
constructor(channel?: Discord.TextChannel | Discord.NewsChannel) {
this.mentions.everyone = false;
this.channel = channel;
if (channel && channel.guild) {
Expand Down
18 changes: 16 additions & 2 deletions test/test_discordmessageprocessor.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import { DiscordBot } from "../src/bot";
import { MockGuild } from "./mocks/guild";
import { MockMember } from "./mocks/member";
import { MockMessage } from "./mocks/message";
import { MockTextChannel } from "./mocks/channel";
import { MockTextChannel, MockNewsChannel } from "./mocks/channel";

// we are a test file and thus need those
/* tslint:disable:no-unused-expression max-file-line-count no-any */
Expand Down Expand Up @@ -208,7 +208,7 @@ describe("DiscordMessageProcessor", () => {
expect(result.body).to.equal("Hello <#3333333>");
expect(result.formattedBody).to.equal("Hello &lt;#3333333&gt;");
});
it("processes channels correctly", async () => {
it("processes text channels correctly", async () => {
const processor = new DiscordMessageProcessor(
"localhost", bot as DiscordBot);
const guild: any = new MockGuild("123", []);
Expand All @@ -222,6 +222,20 @@ describe("DiscordMessageProcessor", () => {
expect(result.formattedBody).to.equal("Hello <a href=\"https://matrix.to/#/#_discord_123" +
"_456:localhost\">#TestChannel</a>");
});
it("processes news channels correctly", async () => {
const processor = new DiscordMessageProcessor(
"localhost", bot as DiscordBot);
const guild: any = new MockGuild("123", []);
const channel = new MockNewsChannel(guild, {id: "456", name: "TestNewsChannel"});
guild.channels.cache.set("456", channel);
const msg = new MockMessage(channel) as any;
msg.embeds = [];
msg.content = "Hello <#456>";
const result = await processor.FormatMessage(msg);
expect(result.body).to.equal("Hello #TestNewsChannel");
expect(result.formattedBody).to.equal("Hello <a href=\"https://matrix.to/#/#_discord_123" +
"_456:localhost\">#TestNewsChannel</a>");
});
it("processes channels without alias correctly", async () => {
const processor = new DiscordMessageProcessor(
"localhost", bot as DiscordBot);
Expand Down