Implement `audit_log_reason` argument #2021

SenseiHiraku · 2022-06-28T00:58:21Z

I've noticed, that adding a reason for the audit_log, as implemented in other Discord API libraries, is not yet fully implemented here.
It may be breaking change for many functions, but it's a necessary one in my eyes, basically an addition to #1354

The audit log types are no longer re-exported in the `model::guild` module. BREAKING CHANGES: - The `audit_log::Action*` enum sub types are renamed to `*Action`. For instance, `ActionChannel` to `ChannelAction`. - The audit log types must be imported directly from the `model::guild::audit_log` module.

…#1885)

…1893) The newtype struct `gateway::WsClient` hides the WebSocket implementation details and is the first step to remove the `async_tungstenite` & `tungstenite` types from the public API. The `WebSocketGatewayClientExt`, `ReceiverExt` and `SenderExt` trait methods are merged into the implementation of the newtype struct. BREAKING CHANGES: - `gateway::WsStream` is replaced by `gateway::WsClient`. - The `gateway::WebSocketGatewayClientExt` trait is removed.

Since `&` is Copy, it’s useless to have a reference on `Option<&'a [u8]>`.

This changes the return type of `http::Typing::stop` to be a simple `bool` rather than `Option<()>`, which doesn't provide useful information that couldn't be expressed with just a `bool`. Co-authored-by: Michael Krasnitski <42564254+mkrasnitski@users.noreply.github.com> Signed-off-by: Miezhiko <Miezhiko@gmail.com>

This changes instances of `ToString` to `Into<String>` whenever ownership of the `String` is necessary. In case it is not, it's simply changed to `&str` to lessen the effects of monomorphization on compile times.

)

Problems with the current setup: - The content of messages with these types is not documented, meaning that it can change anytime. - Not every message type is handled, e.g. boost or thread creation messages do not get their content added. - Overall more possibly unexpected behaviour and less consistency with the API.

This adds a method `Webhook::execute_in_thread` which takes an additional thread ID (which is just a `ChannelId`) parameter. Then, the webhook will execute in that thread, provided it belongs to the webhook's assigned guild channel. This also adds a `thread_id` parameter to `Http::execute_webhook`, which is a breaking change.

This also removes `GuildContainer`, as this was (and historically has been) the only use of it.

This replaces the implementation of `From<Ref>` for `CacheRef` with a private method in order to not expose the dashmap type as part of the public API. Also, this rewords and removes a few clones on types returned from the cache.

The interaction payload for autocompletes is slightly different. It's missing the `resolved` data map and reports only for the current autocompleted option value the `focused` field and its value as a string. The focused option value is modeled as an enum variant of `CommandDataOptionValue`. ``` enum CommandDataOptionValue { Autocomplete { name: String, kind: CommandOptionType, value: String }, } ``` The focused option value can be retrieved via `AutocompleteData::focused_option()` from the `AutocompleteData::options` vector.

…#1942)

…known` events (#1938, #1951) BREAKING CHANGES: Removes the `guild_unavailable` & `unknown` methods from the `EventHandler` trait.

BREAKING CHANGE: This removes methods only usable on user accounts.

The message cache is currently stored as `DashMap<ChannelId, DashMap<MessageId, Message>>` however since the outer `DashMap` already provides interior mutability, it doesn't need another `DashMap` inside. This also stops dashmap being exposed to the public API via `MessageIterator::Item` by removing it (and instead exposes the inner `HashMap`).

The derive macros are grouped into `std` & third party and sorted alphabetically. ``` #[derive(Clone, Copy, Debug, Eq, PartialEq, Deserialize, Serialize)] struct Foo; ```

BREAKING CHANGE: Some enums were missing the `[non_exhaustive]` attribute.

The file was forgotten to delete when the types were moved into the root. See 34bc5fe

The derive macros are grouped into `std` & third party and sorted alphabetically. ``` #[derive(Clone, Copy, Debug, Eq, PartialEq, Deserialize, Serialize)] struct Foo; ```

BREAKING CHANGE: `Cache::channel_messages_field` is replaced by `Cache::channel_messages` returning a reference to the messages map.

This replaces the `[u64; 2]` shard info with `ShardInfo { id: u32, total: u32 }`. Co-authored-by: nickelc <constantin.nickel@gmail.com>

The `enum_number!` macro now takes the whole enum definition and generates `From` trait implementations to convert a value to the enum and back. The implementations can then be picked up by `serde` with `#[serde(from = "u8", into = "u8")]` to (de)serialize the types. ``` enum_number! { #[derive(Clone, Copy, Debug, Deserialize, Serialize)] #[serde(from = "u8", into = "u8")] pub enum Foo { A = 1, B = 2, _ => Unknown(u8), } } ``` BREAKING CHANGE: The `Unknown` variant now takes the unknown value and the removed `fn num() -> u64` method can be replaced with `let v = u8::from(kind)`.

Before `ShardInfo`: `[serenity::gateway::shard]: [Shard [15, 33]] ...` Currently: `[serenity::gateway::shard]: [Shard ShardInfo { id: 15, total: 33 }] ...` After: `[serenity::gateway::shard]: [ShardInfo { id: 15, total: 33 }] ...`

The returned `Result` is already marked as `#[must_use]`.

mkrasnitski · 2022-06-28T01:12:29Z

Thanks for the PR! Unfortunate timing on your part, I suppose. If you look at ~~#1967~~ #2024, we're actually in the middle of an overhaul to how the builders are constructed and executed, which I expect will be finished and merged sometime next month. But, with the new system, adding support for audit_log_reason ought to be pretty easy, either as an additional method on the builder, or as a parameter to the execute function being introduced with every builder. I'm in favor of the former, which implies adding an audit_log_reason field to the builder struct and just marking it #[serde(skip)], and feature-flagging it behind "http".

mkrasnitski · 2022-08-08T02:21:46Z

@SenseiHiraku Now that #2024 has been merged, if you'd like, you can take a stab at re-implementing this (if not let me know and I can tackle it). I think the best way to do so would be to add an optional audit_log_reason field to every builder marked #[serde(skip)], as well as a corresponding method on the builder to set its value. Unfortunately I think it's best to close this PR in its current form and open a new one, as the changes it makes are no longer compatible with the current codebase.

arqunis · 2022-08-27T21:43:44Z

Completed by #2105

nickelc and others added 30 commits June 24, 2022 16:30

Reference the objects within ResolvedTarget instead of cloning them (…

bfce777

…#1885)

Remove useless reference on Option<&T> (#1896)

b8c483e

Since `&` is Copy, it’s useless to have a reference on `Option<&'a [u8]>`.

Remove deprecated interaction type aliases, field and method (#1902)

b403501

Switch to Into<String> when accepting string parameters (#1903)

2786d03

This changes instances of `ToString` to `Into<String>` whenever ownership of the `String` is necessary. In case it is not, it's simply changed to `&str` to lessen the effects of monomorphization on compile times.

Allow having no framework when the framework feature is enabled (#1908

24ec033

)

Remove unneeded futures::iter::stream usage (#1922)

2adbfdf

Add a cache fallback to ChannelId::message (#1924)

84a4500

Change User::has_role to accept just a GuildId (#1927)

b42ee52

This also removes `GuildContainer`, as this was (and historically has been) the only use of it.

Implement suggested TODO fixes (#1928)

055d490

Expose dashmap's wrapped Ref to reduce cloning (#1917)

c9f7304

Move around Boxes to fix clippy::large_enum_variant (#1929)

8ca2cf1

Fix clippy warnings (#1933)

8bb9b7a

Avoid cloning member out of cache in Guild::member (#1934)

4e8f9ce

De-duplicate cache -> http logic from Message::member (#1935)

dc7097b

Clean up previous changes to cache (#1936)

e2df318

This replaces the implementation of `From<Ref>` for `CacheRef` with a private method in order to not expose the dashmap type as part of the public API. Also, this rewords and removes a few clones on types returned from the cache.

Remove references from ShardManagerOptions (#1937)

af90e29

Unasync ShardManager::new (#1940)

e03c4bf

Reduce int size of prune_count methods (#1947)

c4c6eff

Clean and optimise message_builder.rs (#1946)

b1135f5

Remove unused allowed clippy warnings or fix them (#1945)

5bc5274

Use concrete fields instead of HashMap in the GetMessages builder (…

06811d3

…#1942)

Improve event deserialization by sacrificing GuildUnavailable & `Un…

8fc9c39

…known` events (#1938, #1951) BREAKING CHANGES: Removes the `guild_unavailable` & `unknown` methods from the `EventHandler` trait.

Rework manual deserialization implementations (#1938, #1951)

084c545

Remove user-only EditProfile methods (#1959)

601d13f

BREAKING CHANGE: This removes methods only usable on user accounts.

GnomedDev and others added 17 commits June 24, 2022 16:49

Deduplicate a lot of the collector module (#1932)

aa36e15

Group & sort derive macros alphabetically

18f0a18

The derive macros are grouped into `std` & third party and sorted alphabetically. ``` #[derive(Clone, Copy, Debug, Eq, PartialEq, Deserialize, Serialize)] struct Foo; ```

Unify derive & #[non_exhaustive] attributes for number enums (#1999)

ebf28bf

BREAKING CHANGE: Some enums were missing the `[non_exhaustive]` attribute.

Remove unused channel/sticker.rs file

ab4cdde

The file was forgotten to delete when the types were moved into the root. See 34bc5fe

Replace magic number with ChannelType::Stage

8b9cad5

Group & sort derive macros alphabetically

5512ddc

The derive macros are grouped into `std` & third party and sorted alphabetically. ``` #[derive(Clone, Copy, Debug, Eq, PartialEq, Deserialize, Serialize)] struct Foo; ```

Use CacheRef to access channel messages from the cache (#2000)

d6e4e6d

BREAKING CHANGE: `Cache::channel_messages_field` is replaced by `Cache::channel_messages` returning a reference to the messages map.

Make MessageActivityKind's variants upper camel case (#2005)

0c8346f

Reduce size of shard info and turn it into a struct (#1984)

79fa044

This replaces the `[u64; 2]` shard info with `ShardInfo { id: u32, total: u32 }`. Co-authored-by: nickelc <constantin.nickel@gmail.com>

Add UserRef by wrapping temporary cache values in Arc (#1997)

2507a1d

Rework setting and storing of presence data (#2007)

28b1d61

fixup! Use CacheRef for CurrentUser (#1996)

527f341

Remove Shard prefix in ShardInfo logging (#2014)

92a90f1

Before `ShardInfo`: `[serenity::gateway::shard]: [Shard [15, 33]] ...` Currently: `[serenity::gateway::shard]: [Shard ShardInfo { id: 15, total: 33 }] ...` After: `[serenity::gateway::shard]: [ShardInfo { id: 15, total: 33 }] ...`

Remove unneeded #[must_use] attribute

7e6773b

The returned `Result` is already marked as `#[must_use]`.

Implement audit_log_reason argument

e2d7389

github-actions bot added builder Related to the `builder` module. examples Related to Serenity's examples. model Related to the `model` module. labels Jun 28, 2022

Remove unneeded length check

2d41d06

arqunis force-pushed the next branch 3 times, most recently from f06e6e7 to b6d6ce0 Compare July 20, 2022 02:43

arqunis force-pushed the next branch from d109da9 to 3231a8d Compare August 21, 2022 06:18

mkrasnitski mentioned this pull request Aug 25, 2022

Add missing audit log reason support to Http and relevant builders #2105

Merged

arqunis closed this Aug 27, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement `audit_log_reason` argument #2021

Implement `audit_log_reason` argument #2021

SenseiHiraku commented Jun 28, 2022

mkrasnitski commented Jun 28, 2022 •

edited

Loading

mkrasnitski commented Aug 8, 2022

arqunis commented Aug 27, 2022

Implement audit_log_reason argument #2021

Implement audit_log_reason argument #2021

Conversation

SenseiHiraku commented Jun 28, 2022

mkrasnitski commented Jun 28, 2022 • edited Loading

mkrasnitski commented Aug 8, 2022

arqunis commented Aug 27, 2022

Implement `audit_log_reason` argument #2021

Implement `audit_log_reason` argument #2021

mkrasnitski commented Jun 28, 2022 •

edited

Loading