fix(gateway): safely handle more JSON decode failures

more liberal use of DecodeThrowable

hopefully reduces the likelihood of ready event decode failures

Author: cryptoAlgorithm

Sources/DiscordKitCore/Objects/Data/Guild.swift

@@ -38,7 +38,7 @@ public enum GuildFeature: String, Codable {
 }
 
 public struct Guild: GatewayData, Equatable, Identifiable {
-	public init(id: Snowflake, name: String, icon: String? = nil, icon_hash: String? = nil, splash: String? = nil, discovery_splash: String? = nil, owner: Bool? = nil, owner_id: Snowflake, permissions: String? = nil, region: String? = nil, afk_channel_id: Snowflake? = nil, afk_timeout: Int, widget_enabled: Bool? = nil, widget_channel_id: Snowflake? = nil, verification_level: VerificationLevel, default_message_notifications: MessageNotifLevel, explicit_content_filter: ExplicitContentFilterLevel, roles: [DecodableThrowable<Role>], emojis: [DecodableThrowable<Emoji>], features: [DecodableThrowable<GuildFeature>], mfa_level: MFALevel, application_id: Snowflake? = nil, system_channel_id: Snowflake? = nil, system_channel_flags: Int, rules_channel_id: Snowflake? = nil, joined_at: Date? = nil, large: Bool? = nil, unavailable: Bool? = nil, member_count: Int? = nil, voice_states: [VoiceState]? = nil, members: [Member]? = nil, channels: [Channel]? = nil, threads: [Channel]? = nil, presences: [PresenceUpdate]? = nil, max_presences: Int? = nil, max_members: Int? = nil, vanity_url_code: String? = nil, description: String? = nil, banner: String? = nil, premium_tier: PremiumLevel, premium_subscription_count: Int? = nil, preferred_locale: Locale, public_updates_channel_id: Snowflake? = nil, max_video_channel_users: Int? = nil, approximate_member_count: Int? = nil, approximate_presence_count: Int? = nil, welcome_screen: GuildWelcomeScreen? = nil, nsfw_level: NSFWLevel, stage_instances: [StageInstance]? = nil, stickers: [Sticker]? = nil, guild_scheduled_events: [GuildScheduledEvent]? = nil, premium_progress_bar_enabled: Bool) {
+	public init(id: Snowflake, name: String, icon: String? = nil, icon_hash: String? = nil, splash: String? = nil, discovery_splash: String? = nil, owner: Bool? = nil, owner_id: Snowflake, permissions: String? = nil, region: String? = nil, afk_channel_id: Snowflake? = nil, afk_timeout: Int, widget_enabled: Bool? = nil, widget_channel_id: Snowflake? = nil, verification_level: VerificationLevel, default_message_notifications: MessageNotifLevel, explicit_content_filter: ExplicitContentFilterLevel, roles: [DecodeThrowable<Role>], emojis: [DecodeThrowable<Emoji>], features: [DecodeThrowable<GuildFeature>], mfa_level: MFALevel, application_id: Snowflake? = nil, system_channel_id: Snowflake? = nil, system_channel_flags: Int, rules_channel_id: Snowflake? = nil, joined_at: Date? = nil, large: Bool? = nil, unavailable: Bool? = nil, member_count: Int? = nil, voice_states: [VoiceState]? = nil, members: [Member]? = nil, channels: [Channel]? = nil, threads: [Channel]? = nil, presences: [PresenceUpdate]? = nil, max_presences: Int? = nil, max_members: Int? = nil, vanity_url_code: String? = nil, description: String? = nil, banner: String? = nil, premium_tier: PremiumLevel, premium_subscription_count: Int? = nil, preferred_locale: Locale, public_updates_channel_id: Snowflake? = nil, max_video_channel_users: Int? = nil, approximate_member_count: Int? = nil, approximate_presence_count: Int? = nil, welcome_screen: GuildWelcomeScreen? = nil, nsfw_level: NSFWLevel, stage_instances: [StageInstance]? = nil, stickers: [Sticker]? = nil, guild_scheduled_events: [GuildScheduledEvent]? = nil, premium_progress_bar_enabled: Bool) {
 		self.id = id
 		self.name = name
 		self.icon = icon
@@ -109,7 +109,7 @@ public struct Guild: GatewayData, Equatable, Identifiable {
     public let verification_level: VerificationLevel
     public let default_message_notifications: MessageNotifLevel
     public let explicit_content_filter: ExplicitContentFilterLevel
-    public let features: [DecodableThrowable<GuildFeature>]
+    public let features: [DecodeThrowable<GuildFeature>]
     public let mfa_level: MFALevel
     public let application_id: Snowflake? // For bot-created guilds
     public let system_channel_id: Snowflake? // ID of channel for system-created messages
@@ -149,8 +149,8 @@ public struct PreloadedGuild: GatewayData, Identifiable, Equatable {
     }
 
     public let version: Int
-    public let channels: [Channel]
-    public let emojis: [DecodableThrowable<Emoji>]
+    public let channels: [DecodeThrowable<Channel>]
+    public let emojis: [DecodeThrowable<Emoji>]
     public let id: Snowflake
     public let joined_at: Date
     public let large: Bool
@@ -159,19 +159,19 @@ public struct PreloadedGuild: GatewayData, Identifiable, Equatable {
     /// Members in the guild
     ///
     /// > User accounts will only receive the client's member and users in voice channels, and 
-    public let members: [Member]?
+    public let members: [DecodeThrowable<Member>]?
 
     /// Number of "boosts" the server has
     public let premium_subscription_count: Int
     public let properties: Guild
-    public let roles: [DecodableThrowable<Role>]
-    public let stickers: [Sticker]
+    public let roles: [DecodeThrowable<Role>]
+    public let stickers: [DecodeThrowable<Sticker>]
     // public let threads:
 
     /// Convenience init for creating DM channel
     public init(channels: [Channel], properties: Guild) {
         self.version = 0
-        self.channels = channels
+        self.channels = channels.map { DecodeThrowable($0) }
         self.emojis = []
         self.id = "@me"
         self.joined_at = .distantPast

Sources/DiscordKitCore/Objects/Data/Sticker.swift

@@ -9,16 +9,17 @@ import Foundation
 
 public enum StickerType: Int, Codable {
     case standard = 1
-    case guild = 2
+    case guild
 }
 
 public enum StickerFormat: Int, Codable {
     case png = 1
-    case aPNG = 2 // Animated PNG
-    case lottie = 3
+    case aPNG // Animated PNG
+    case lottie
+    case gif
 }
 
-public struct Sticker: Codable, GatewayData {
+public struct Sticker: Codable, GatewayData, Identifiable {
     public let id: Snowflake
     public let pack_id: Snowflake? // For standard stickers, id of the pack the sticker is from
     public let name: String
@@ -40,7 +41,7 @@ public struct StickerItem: Codable, Identifiable {
     public let format_type: StickerFormat
 }
 
-public struct StickerPack: Codable, GatewayData {
+public struct StickerPack: Codable, GatewayData, Identifiable {
     public let id: Snowflake
     public let stickers: [StickerItem]
     public let name: String

Sources/DiscordKitCore/Objects/Gateway/Event/ReadyEvt.swift

@@ -13,13 +13,13 @@ public struct ReadyEvt: Decodable, GatewayData {
     public let v: Int
     public let user: CurrentUser
     public let users: [User]
-    public let guilds: [PreloadedGuild]
+    public let guilds: [DecodeThrowable<PreloadedGuild>]
     public let session_id: String
     public let user_settings: UserSettings? // Depreciated, no longer sent
     /// Protobuf of user settings
     public let user_settings_proto: String
     /// DMs for this user
-    public let private_channels: [Channel]
+    public let private_channels: [DecodeThrowable<Channel>]
 
     public let merged_members: [[Member]]
 

Sources/DiscordKitCore/REST/APICurrentUser.swift

@@ -13,7 +13,7 @@ import Foundation
 public extension DiscordREST {
     // MARK: Get Current User DMs
     // GET /users/@me/channels
-    func getDMs() async throws -> [DecodableThrowable<Channel>] {
+    func getDMs() async throws -> [DecodeThrowable<Channel>] {
         return try await getReq(path: "users/@me/channels")
     }
 

Sources/DiscordKitCore/REST/APIGuild.swift

@@ -13,7 +13,7 @@ public extension DiscordREST {
     /// Get Guild Channels
     ///
     /// > GET: `/guilds/{guild.id}/channels`
-    func getGuildChannels(id: Snowflake) async throws -> [DecodableThrowable<Channel>] {
+    func getGuildChannels(id: Snowflake) async throws -> [DecodeThrowable<Channel>] {
         return try await getReq(path: "guilds/\(id)/channels")
     }
 

Sources/DiscordKitCore/Utils/DecodableThrowable.swift renamed to Sources/DiscordKitCore/Utils/DecodeThrowable.swift

@@ -13,12 +13,26 @@ import Foundation
 /// decoding errors to be removed, instead of the whole struct failing
 /// to decode. Use a compactMap with `try? result.get()` to remove
 /// items that failed to decode.
-public struct DecodableThrowable<T: Decodable>: Decodable {
+public struct DecodeThrowable<T: Decodable>: Decodable {
     /// Decoded result, use `try? .get()` to retrive the value
     /// or nil if decoding failed
     public let result: Result<T, Error>
 
+    public func unwrap() throws -> T {
+        try result.get()
+    }
+
+    public init(_ wrapped: T) {
+        result = .success(wrapped)
+    }
+
     public init(from decoder: Decoder) throws {
         result = Result(catching: { try T(from: decoder) })
     }
 }
+
+public extension Array {
+    func compactUnwrap<T>() -> [T] where Element == DecodeThrowable<T> {
+        self.compactMap { try? $0.unwrap() }
+    }
+}