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

feat/fix(GuildAuditLogs): handle new event types #3602

Merged
merged 5 commits into from
Feb 24, 2020
Merged

feat/fix(GuildAuditLogs): handle new event types #3602

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cec9962
feat/fix(GuildAuditLogs): handle new event types
SpaceEEC Nov 28, 2019
092a87b
Merge branch 'master' into feat/audit_logs
SpaceEEC Jan 18, 2020
1054c02
fix(GuildAuditLogsEntry): coerce to numbers, simplify extra for delet…
SpaceEEC Feb 11, 2020
9f358d2
merge master
SpaceEEC Feb 24, 2020
d2b9ce9
fix(GuildAuditLogsEntry): do not revert 'type' extra
SpaceEEC Feb 24, 2020
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
109 changes: 84 additions & 25 deletions src/structures/GuildAuditLogs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
'use strict';

const Collection = require('../util/Collection');
const Integration = require('./Integration');
const Snowflake = require('../util/Snowflake');
const Webhook = require('./Webhook');
const Util = require('../util/Util');
const PartialTypes = require('../util/Constants');
const { PartialTypes } = require('../util/Constants');

/**
* The target type of an entry, e.g. `GUILD`. Here are the available types:
Expand All @@ -16,6 +17,7 @@ const PartialTypes = require('../util/Constants');
* * WEBHOOK
* * EMOJI
* * MESSAGE
* * INTEGRATION
* @typedef {string} AuditLogTargetType
*/

Expand All @@ -34,6 +36,7 @@ const Targets = {
WEBHOOK: 'WEBHOOK',
EMOJI: 'EMOJI',
MESSAGE: 'MESSAGE',
INTEGRATION: 'INTEGRATION',
UNKNOWN: 'UNKNOWN',
};

Expand Down Expand Up @@ -141,6 +144,18 @@ class GuildAuditLogs {
}
}

/**
* Cached integrations
* @type {Collection<Snowflake, Integration>}
* @private
*/
this.integrations = new Collection();
if (data.integrations) {
for (const integration of data.integrations) {
this.integrations.set(integration.id, new Integration(guild.client, integration, guild));
}
}

/**
* The entries for this guild's audit logs
* @type {Collection<Snowflake, GuildAuditLogsEntry>}
Expand Down Expand Up @@ -169,9 +184,10 @@ class GuildAuditLogs {
* * An emoji
* * An invite
* * A webhook
* * An integration
* * An object with an id key if target was deleted
* * An object where the keys represent either the new value or the old value
* @typedef {?Object|Guild|User|Role|GuildEmoji|Invite|Webhook} AuditLogEntryTarget
* @typedef {?Object|Guild|User|Role|GuildEmoji|Invite|Webhook|Integration} AuditLogEntryTarget
*/

/**
Expand All @@ -188,6 +204,7 @@ class GuildAuditLogs {
if (target < 60) return Targets.WEBHOOK;
if (target < 70) return Targets.EMOJI;
if (target < 80) return Targets.MESSAGE;
if (target < 90) return Targets.INTEGRATION;
return Targets.UNKNOWN;
}

Expand All @@ -210,10 +227,13 @@ class GuildAuditLogs {
Actions.CHANNEL_CREATE,
Actions.CHANNEL_OVERWRITE_CREATE,
Actions.MEMBER_BAN_REMOVE,
Actions.BOT_ADD,
Actions.ROLE_CREATE,
Actions.INVITE_CREATE,
Actions.WEBHOOK_CREATE,
Actions.EMOJI_CREATE,
Actions.MESSAGE_PIN,
Actions.INTEGRATION_CREATE,
].includes(action)) return 'CREATE';

if ([
Expand All @@ -222,11 +242,15 @@ class GuildAuditLogs {
Actions.MEMBER_KICK,
Actions.MEMBER_PRUNE,
Actions.MEMBER_BAN_ADD,
Actions.MEMBER_DISCONNECT,
Actions.ROLE_DELETE,
Actions.INVITE_DELETE,
Actions.WEBHOOK_DELETE,
Actions.EMOJI_DELETE,
Actions.MESSAGE_DELETE,
Actions.MESSAGE_BULK_DELETE,
Actions.MESSAGE_UNPIN,
Actions.INTEGRATION_DELETE,
].includes(action)) return 'DELETE';

if ([
Expand All @@ -235,10 +259,12 @@ class GuildAuditLogs {
Actions.CHANNEL_OVERWRITE_UPDATE,
Actions.MEMBER_UPDATE,
Actions.MEMBER_ROLE_UPDATE,
Actions.MEMBER_MOVE,
Actions.ROLE_UPDATE,
Actions.INVITE_UPDATE,
Actions.WEBHOOK_UPDATE,
Actions.EMOJI_UPDATE,
Actions.INTEGRATION_UPDATE,
].includes(action)) return 'UPDATE';

return 'ALL';
Expand Down Expand Up @@ -312,49 +338,73 @@ class GuildAuditLogsEntry {
* @type {?Object|Role|GuildMember}
*/
this.extra = null;
if (data.options) {
if (data.action_type === Actions.MEMBER_PRUNE) {
switch (data.action_type) {
case Actions.MEMBER_PRUNE:
this.extra = {
removed: data.options.members_removed,
days: data.options.delete_member_days,
removed: Number(data.options.members_removed),
days: Number(data.options.delete_member_days),
};
} else if (data.action_type === Actions.MESSAGE_DELETE) {
break;

case Actions.MEMBER_MOVE:
case Actions.MESSAGE_DELETE:
case Actions.MESSAGE_BULK_DELETE:
this.extra = {
channel: guild.channels.cache.get(data.options.channel_id) || { id: data.options.channel_id },
count: Number(data.options.count),
};
break;

case Actions.MESSAGE_PIN:
case Actions.MESSAGE_UNPIN:
this.extra = {
count: data.options.count,
channel: guild.channels.cache.get(data.options.channel_id),
channel: guild.client.channels.cache.get(data.options.channel_id) || { id: data.options.channel_id },
messageID: data.options.message_id,
};
} else if (data.action_type === Actions.MESSAGE_BULK_DELETE) {
break;

case Actions.MEMBER_DISCONNECT:
this.extra = {
count: data.options.count,
count: Number(data.options.count),
};
} else {
break;

case Actions.CHANNEL_OVERWRITE_CREATE:
case Actions.CHANNEL_OVERWRITE_UPDATE:
case Actions.CHANNEL_OVERWRITE_DELETE:
switch (data.options.type) {
case 'member':
this.extra = guild.members.cache.get(data.options.id);
if (!this.extra) this.extra = { id: data.options.id };
this.extra = guild.members.cache.get(data.options.id) ||
{ id: data.options.id, type: 'member' };
break;

case 'role':
this.extra = guild.roles.cache.get(data.options.id);
if (!this.extra) this.extra = { id: data.options.id, name: data.options.role_name };
this.extra = guild.roles.cache.get(data.options.id) ||
{ id: data.options.id, name: data.options.role_name, type: 'role' };
break;

default:
break;
}
}
}
break;

default:
break;
}

/**
* The target of this entry
* @type {?AuditLogEntryTarget}
*/
this.target = null;
if (targetType === Targets.UNKNOWN) {
/**
* The target of this entry
* @type {AuditLogEntryTarget}
*/
this.target = this.changes.reduce((o, c) => {
o[c.key] = c.new || c.old;
return o;
}, {});
this.target.id = data.target_id;
} else if (targetType === Targets.USER) {
// MEMBER_DISCONNECT and similar types do not provide a target_id.
} else if (targetType === Targets.USER && data.target_id) {
this.target = guild.client.options.partials.includes(PartialTypes.USER) ?
guild.client.users.add({ id: data.target_id }) :
guild.client.users.cache.get(data.target_id);
Expand Down Expand Up @@ -386,8 +436,17 @@ class GuildAuditLogsEntry {
}
});
} else if (targetType === Targets.MESSAGE) {
this.target = guild.client.users.cache.get(data.target_id);
} else {
// Discord sends a channel id for the MESSAGE_BULK_DELETE action type.
this.target = data.action_type === Actions.MESSAGE_BULK_DELETE ?
guild.channels.cache.get(data.target_id) || { id: data.target_id } :
guild.client.users.cache.get(data.target_id);
} else if (targetType === Targets.INTEGRATION) {
this.target = logs.integrations.get(data.target_id) ||
new Integration(guild.client, this.changes.reduce((o, c) => {
o[c.key] = c.new || c.old;
return o;
}, { id: data.target_id }), guild);
} else if (data.target_id) {
this.target = guild[`${targetType.toLowerCase()}s`].cache.get(data.target_id) || { id: data.target_id };
}
}
Expand Down
5 changes: 4 additions & 1 deletion typings/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -773,6 +773,7 @@ declare module 'discord.js' {
export class GuildAuditLogs {
constructor(guild: Guild, data: object);
private webhooks: Collection<Snowflake, Webhook>;
private integrations: Collection<Snowflake, Integration>;

public entries: Collection<Snowflake, GuildAuditLogsEntry>;

Expand All @@ -796,7 +797,7 @@ declare module 'discord.js' {
public extra: object | Role | GuildMember | null;
public id: Snowflake;
public reason: string | null;
public target: Guild | User | Role | GuildEmoji | Invite | Webhook;
public target: Guild | User | Role | GuildEmoji | Invite | Webhook | Integration | null;
public targetType: GuildAuditLogsTarget;
public toJSON(): object;
}
Expand Down Expand Up @@ -2300,6 +2301,8 @@ declare module 'discord.js' {
WEBHOOK?: string;
EMOJI?: string;
MESSAGE?: string;
INTEGRATION?: string;
UNKNOWN?: string;
}

type GuildChannelResolvable = Snowflake | GuildChannel;
Expand Down