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

fix(model, http)!: fix role position update payload and allow audit log reason #2342

Merged
merged 3 commits into from
Jul 13, 2024
Merged
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
7 changes: 5 additions & 2 deletions twilight-http/src/client/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,10 @@ use tokio::time;
use twilight_http_ratelimiting::Ratelimiter;
use twilight_model::{
channel::{message::AllowedMentions, ChannelType},
guild::{auto_moderation::AutoModerationEventType, scheduled_event::PrivacyLevel, MfaLevel},
guild::{
auto_moderation::AutoModerationEventType, scheduled_event::PrivacyLevel, MfaLevel,
RolePosition,
},
http::{channel_position::Position, permission_overwrite::PermissionOverwrite},
id::{
marker::{
Expand Down Expand Up @@ -1680,7 +1683,7 @@ impl Client {
pub const fn update_role_positions<'a>(
&'a self,
guild_id: Id<GuildMarker>,
roles: &'a [(Id<RoleMarker>, u64)],
roles: &'a [RolePosition],
) -> UpdateRolePositions<'a> {
UpdateRolePositions::new(self, guild_id, roles)
}
Expand Down
6 changes: 4 additions & 2 deletions twilight-http/src/request/audit_reason.rs
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ mod private {
emoji::{CreateEmoji, DeleteEmoji, UpdateEmoji},
integration::DeleteGuildIntegration,
member::{AddRoleToMember, RemoveMember, RemoveRoleFromMember, UpdateGuildMember},
role::{CreateRole, DeleteRole, UpdateRole},
role::{CreateRole, DeleteRole, UpdateRole, UpdateRolePositions},
sticker::{CreateGuildSticker, UpdateGuildSticker},
update_guild_onboarding::UpdateGuildOnboarding,
CreateGuildChannel, CreateGuildPrune, UpdateCurrentMember, UpdateGuild, UpdateGuildMfa,
Expand Down Expand Up @@ -95,6 +95,7 @@ mod private {
impl Sealed for UpdateGuildSticker<'_> {}
impl Sealed for UpdateGuildWidgetSettings<'_> {}
impl Sealed for UpdateRole<'_> {}
impl Sealed for UpdateRolePositions<'_> {}
impl Sealed for UpdateThread<'_> {}
impl Sealed for UpdateWebhook<'_> {}
}
Expand All @@ -115,7 +116,7 @@ mod tests {
emoji::{CreateEmoji, DeleteEmoji, UpdateEmoji},
integration::DeleteGuildIntegration,
member::{AddRoleToMember, RemoveMember, RemoveRoleFromMember, UpdateGuildMember},
role::{CreateRole, DeleteRole, UpdateRole},
role::{CreateRole, DeleteRole, UpdateRole, UpdateRolePositions},
sticker::{CreateGuildSticker, UpdateGuildSticker},
CreateGuildChannel, CreateGuildPrune, UpdateCurrentMember, UpdateGuild,
},
Expand Down Expand Up @@ -157,5 +158,6 @@ mod tests {
assert_impl_all!(UpdateGuildMember<'_>: AuditLogReason<'static>);
assert_impl_all!(UpdateGuildSticker<'_>: AuditLogReason<'static>);
assert_impl_all!(UpdateRole<'_>: AuditLogReason<'static>);
assert_impl_all!(UpdateRolePositions<'_>: AuditLogReason<'static>);
assert_impl_all!(UpdateWebhook<'_>: AuditLogReason<'static>);
}
35 changes: 24 additions & 11 deletions twilight-http/src/request/guild/role/update_role_positions.rs
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
use crate::{
client::Client,
error::Error,
request::{Request, TryIntoRequest},
request::{self, AuditLogReason, Request, TryIntoRequest},
response::{marker::ListBody, Response, ResponseFuture},
routing::Route,
};
use std::future::IntoFuture;
use twilight_model::{
guild::Role,
id::{
marker::{GuildMarker, RoleMarker},
Id,
},
guild::{Role, RolePosition},
id::{marker::GuildMarker, Id},
};
use twilight_validate::request::{audit_reason as validate_audit_reason, ValidationError};

/// Modify the position of the roles.
///
Expand All @@ -21,23 +19,33 @@ use twilight_model::{
pub struct UpdateRolePositions<'a> {
guild_id: Id<GuildMarker>,
http: &'a Client,
roles: &'a [(Id<RoleMarker>, u64)],
roles: &'a [RolePosition],
reason: Result<Option<&'a str>, ValidationError>,
}

impl<'a> UpdateRolePositions<'a> {
pub(crate) const fn new(
http: &'a Client,
guild_id: Id<GuildMarker>,
roles: &'a [(Id<RoleMarker>, u64)],
roles: &'a [RolePosition],
) -> Self {
Self {
guild_id,
http,
roles,
reason: Ok(None),
}
}
}

impl<'a> AuditLogReason<'a> for UpdateRolePositions<'a> {
fn reason(mut self, reason: &'a str) -> Self {
self.reason = validate_audit_reason(reason).and(Ok(Some(reason)));

self
}
}

impl IntoFuture for UpdateRolePositions<'_> {
type Output = Result<Response<ListBody<Role>>, Error>;

Expand All @@ -55,10 +63,15 @@ impl IntoFuture for UpdateRolePositions<'_> {

impl TryIntoRequest for UpdateRolePositions<'_> {
fn try_into_request(self) -> Result<Request, Error> {
Request::builder(&Route::UpdateRolePositions {
let mut request = Request::builder(&Route::UpdateRolePositions {
guild_id: self.guild_id.get(),
})
.json(&self.roles)
.build()
.json(&self.roles);

if let Some(reason) = self.reason.map_err(Error::validation)? {
request = request.headers(request::audit_header(reason)?);
}

request.build()
}
}
8 changes: 5 additions & 3 deletions twilight-model/src/guild/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ mod preview;
mod prune;
mod role;
mod role_flags;
mod role_position;
mod role_tags;
mod system_channel_flags;
mod unavailable_guild;
Expand All @@ -54,9 +55,10 @@ pub use self::{
integration_expire_behavior::IntegrationExpireBehavior, integration_type::GuildIntegrationType,
member::Member, member_flags::MemberFlags, mfa_level::MfaLevel, partial_guild::PartialGuild,
partial_member::PartialMember, premium_tier::PremiumTier, preview::GuildPreview,
prune::GuildPrune, role::Role, role_flags::RoleFlags, role_tags::RoleTags,
system_channel_flags::SystemChannelFlags, unavailable_guild::UnavailableGuild,
vanity_url::VanityUrl, verification_level::VerificationLevel, widget::GuildWidget,
prune::GuildPrune, role::Role, role_flags::RoleFlags, role_position::RolePosition,
role_tags::RoleTags, system_channel_flags::SystemChannelFlags,
unavailable_guild::UnavailableGuild, vanity_url::VanityUrl,
verification_level::VerificationLevel, widget::GuildWidget,
};

use super::gateway::presence::PresenceListDeserializer;
Expand Down
41 changes: 41 additions & 0 deletions twilight-model/src/guild/role_position.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
use crate::id::{marker::RoleMarker, Id};
use serde::{Deserialize, Serialize};

#[derive(Clone, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
/// Data used to update the positions of roles.
pub struct RolePosition {
/// Role identifier.
pub id: Id<RoleMarker>,
/// Sorting position of the role.
pub position: u64,
}

#[cfg(test)]
mod tests {
use super::{Id, RolePosition};
use serde_test::Token;

#[test]
fn role_position() {
let role_position = RolePosition {
id: Id::new(123),
position: 12,
};

serde_test::assert_tokens(
&role_position,
&[
Token::Struct {
name: "RolePosition",
len: 2,
},
Token::Str("id"),
Token::NewtypeStruct { name: "Id" },
Token::Str("123"),
Token::Str("position"),
Token::U64(12),
Token::StructEnd,
],
);
}
}