feat(user): update for new user ready payload format

Author: cryptoAlgorithm

Sources/DiscordKit/Gateway/DiscordGateway.swift

@@ -200,7 +200,7 @@ public class DiscordGateway: ObservableObject {
         var modifiedGuild = updatedGuild
 
         // ``GatewayEvent.guildUpdate`` events are missing data that is only present in the initial ``GatewayEvent.ready`` event, so we need to copy those properties over manually.
-        modifiedGuild.joined_at = existingGuild.joined_at
+        /*modifiedGuild.joined_at = existingGuild.joined_at
         modifiedGuild.large = existingGuild.large
         modifiedGuild.unavailable = existingGuild.unavailable
         modifiedGuild.member_count = existingGuild.member_count
@@ -210,9 +210,9 @@ public class DiscordGateway: ObservableObject {
         modifiedGuild.threads = existingGuild.threads
         modifiedGuild.presences = existingGuild.presences
         modifiedGuild.stage_instances = existingGuild.stage_instances
-        modifiedGuild.guild_scheduled_events = existingGuild.guild_scheduled_events
+        modifiedGuild.guild_scheduled_events = existingGuild.guild_scheduled_events*/
 
-        cache.appendOrReplace(modifiedGuild)
+        // cache.appendOrReplace(modifiedGuild)
     }
 
     private func handleProtoUpdate(proto: String) {
@@ -260,14 +260,14 @@ public class DiscordGateway: ObservableObject {
             }
 
         // MARK: Guild events
-        case .guildCreate(let guild): cache.appendOrReplace(guild)
+        // case .guildCreate(let guild): cache.appendOrReplace(guild)
 
         case .guildDelete(let guild): cache.remove(guild)
 
         case .guildUpdate(let guild): handleGuildUpdate(guild)
 
         // MARK: User updates
-        case .userUpdate(let currentUser): cache.user = currentUser
+        case .userUpdate(let currentUser): cache.replace(currentUser)
 
         case .settingsProtoUpdate(let protoUpdate):
             guard !protoUpdate.partial else {

Sources/DiscordKit/Gateway/GatewayCachedState.swift

@@ -15,17 +15,19 @@ public class CachedState: ObservableObject {
     /// Dictionary of guilds the user is in
     ///
     /// > The guild's ID is its key
-    public private(set) var guilds: [Snowflake: Guild] = [:]
+    @Published public private(set) var guilds: [Snowflake: PreloadedGuild] = [:]
+
+    @Published public private(set) var members: [Snowflake: Member] = [:]
 
     /// DM channels the user is in
-	public var dms: [Channel] = []
+    @Published public private(set) var dms: [Channel] = []
 
     /// Cached object of current user
-	public var user: CurrentUser?
+    @Published public private(set) var user: CurrentUser?
 
     /// Cached users, initially populated from `READY` event and might
     /// grow over time
-    public private(set) var users: [Snowflake: User] = [:]
+    @Published public private(set) var users: [Snowflake: User] = [:]
 
     /// Populates the cache using the provided event.
     /// - Parameter event: An incoming Gateway "ready" event.
@@ -34,13 +36,17 @@ public class CachedState: ObservableObject {
         dms = event.private_channels
         user = event.user
         event.users.forEach(appendOrReplace(_:))
+        event.merged_members.enumerated().forEach { (idx, guildMembers) in
+            members[event.guilds[idx].id] = guildMembers.first(where: { $0.user_id == event.user.id })
+        }
+        print(members)
     }
 
-    // MARK: Guilds
+    // MARK: - Guilds
 
     /// Updates or appends the provided guild.
     /// - Parameter guild: The guild you want to update or append to the cache.
-    func appendOrReplace(_ guild: Guild) {
+    func appendOrReplace(_ guild: PreloadedGuild) {
         guilds.updateValue(guild, forKey: guild.id)
     }
 
@@ -50,7 +56,7 @@ public class CachedState: ObservableObject {
         guilds.removeValue(forKey: guild.id)
     }
 
-    // MARK: Channels
+    // MARK: - Channels
 
     /// Appends the provided channel to the appropriate cached guild.
     /// - Parameter channel: The channel to append.
@@ -59,7 +65,7 @@ public class CachedState: ObservableObject {
             return
         }
 
-        guilds[identifier]?.channels?.append(channel)
+        // guilds[identifier]?.channels?.append(channel)
     }
 
     /// Removes the provided channel from the appropriate cached guild.
@@ -69,13 +75,15 @@ public class CachedState: ObservableObject {
             return
         }
 
-        guilds[identifier]?.channels?.removeAll(matchingIdentifierFor: channel)
+        // guilds[
+
+        // guilds[identifier]?.channels?.removeAll(matchingIdentifierFor: channel)
     }
 
     /// Replaces the first channel with an identifier that matches the provided channel's identifier..
     /// - Parameter channel: The channel to replace
     func replace(_ channel: Channel) {
-        guard
+        /*guard
             let guildID = channel.guild_id,
             let channelIndex = guilds[guildID]?
                 .channels?
@@ -84,10 +92,10 @@ public class CachedState: ObservableObject {
             return
         }
 
-        guilds[guildID]?.channels?[channelIndex] = channel
+        guilds[guildID]?.channels?[channelIndex] = channel*/
     }
 
-    // MARK: Messages
+    // MARK: - Messages
 
     /// Appends or replaces  the given message within the appropriate channel.
     /// - Parameter message: The message to append.
@@ -97,11 +105,16 @@ public class CachedState: ObservableObject {
         }
     }
 
-    // MARK: Users
+    // MARK: - Users
 
     /// Appends or replaces the provided user in the cache.
     /// - Parameter user: The user to cache.
     func appendOrReplace(_ user: User) {
         users.updateValue(user, forKey: user.id)
     }
+
+    /// Replaces the current user with the provided one
+    func replace(_ user: CurrentUser) {
+        self.user = user
+    }
 }

Sources/DiscordKitCore/DiscordKitConfig.swift

@@ -47,8 +47,8 @@ public struct GatewayConnProperties: OutgoingGatewayData {
         device: String? = nil,
         release_channel: String? = nil,
         client_version: String? = nil,
-        os_version: String? = nil,
-        os_arch: String? = nil,
+        os_version: String? = "22.4.0",
+        os_arch: String? = "arm64",
         system_locale: String? = nil,
         client_build_number: Int? = nil
     ) {
@@ -250,8 +250,8 @@ public struct DiscordKitConfig {
     /// Currently the only missing piece of emulating the official
     /// desktop client completely is ETF packing/unpacking.
     public static let clientParity = ClientParityVersion(
-        version: "0.0.283",
-        buildNumber: 115689,
+        version: "0.0.296",
+        buildNumber: 197575,
         releaseCh: .canary,
         electronVersion: "13.6.6"
     )

Sources/DiscordKitCore/Gateway/GatewayIdentify.swift

@@ -19,21 +19,24 @@ public extension RobustWebSocket {
     /// not present in the keychain
     internal func getIdentify() -> GatewayIdentify? {
         return GatewayIdentify(
-            token: self.token,
+            token: token,
             properties: DiscordKitConfig.default.properties,
             compress: false,
             large_threshold: nil,
             shard: nil,
             presence: GatewayPresenceUpdate(since: 0, activities: [], status: .online, afk: false),
             client_state: DiscordKitConfig.default.isBot ? nil : ClientState( // Just a dummy client_state
-                guild_hashes: GuildHashes(),
+                api_code_version: 0,
+                guild_versions: .init(),
                 highest_last_message_id: "0",
+                initial_guild_id: nil,
+                private_channels_version: "0",
                 read_state_version: 0,
                 user_guild_settings_version: -1,
                 user_settings_version: -1
             ),
-            capabilities: DiscordKitConfig.default.isBot ? nil : 0b1111111101, // TODO: Reverse engineer this
-            intents: DiscordKitConfig.default.intents
+            capabilities: DiscordKitConfig.default.isBot ? nil : 8189, // TODO: Reverse engineer this
+            intents: DiscordKitConfig.default.isBot ? DiscordKitConfig.default.intents : nil
         )
     }
 

Sources/DiscordKitCore/Gateway/RobustWebSocket.swift

@@ -163,28 +163,31 @@ public class RobustWebSocket: NSObject {
     }
 
     private func attachSockReceiveListener() {
-        socket.receive { [weak self] result in
+        socket.receive { [unowned self] result in
             // print(result)
             switch result {
             case .success(let message):
                 do {
                     switch message {
                     case .data(let data):
-                        if let decompressed = self?.decompressor.push_data(data) {
-                            try self?.handleMessage(with: decompressed)
-                        } else { Self.log.trace("Decompression did not return any result - compressed packet is not complete") }
-                    case .string(let str): try self?.handleMessage(with: str)
+                        if let decompressed = decompressor.push_data(data) {
+                            // print(decompressed)
+                            try handleMessage(with: decompressed)
+                        } else {
+                            Self.log.trace("Decompression did not return any result - compressed packet is not complete")
+                        }
+                    case .string(let str): try handleMessage(with: str)
                     @unknown default: Self.log.warning("Unknown sock message case!")
                     }
                 } catch {
                     // TODO: Add handler for decoding errors
                     Self.log.warning("Error decoding message", metadata: ["error": "\(error)"])
                 }
-                self?.attachSockReceiveListener()
+                attachSockReceiveListener()
             case .failure(let error):
                 // If an error is encountered here, the connection is probably broken
                 Self.log.error("Receive error", metadata: ["error": "\(error.localizedDescription)"])
-                self?.forceClose()
+                forceClose()
             }
         }
     }
@@ -343,6 +346,11 @@ public class RobustWebSocket: NSObject {
         session = URLSession(configuration: .default, delegate: self, delegateQueue: queue)
         connect()
     }
+
+    // Gracefully disconnect when deinitialised
+    deinit {
+        close(code: .normalClosure)
+    }
 }
 
 public typealias ReconnectDelayClosure = (URLSessionWebSocketTask.CloseCode?, Int) -> TimeInterval?

Sources/DiscordKitCore/Objects/Data/Guild.swift

@@ -58,8 +58,6 @@ public struct Guild: GatewayData, Equatable, Identifiable {
 		self.verification_level = verification_level
 		self.default_message_notifications = default_message_notifications
 		self.explicit_content_filter = explicit_content_filter
-		self.roles = roles
-		self.emojis = emojis
 		self.features = features
 		self.mfa_level = mfa_level
 		self.application_id = application_id
@@ -71,9 +69,6 @@ public struct Guild: GatewayData, Equatable, Identifiable {
 		self.unavailable = unavailable
 		self.member_count = member_count
 		self.voice_states = voice_states
-		self.members = members
-		self.channels = channels
-		self.threads = threads
 		self.presences = presences
 		self.max_presences = max_presences
 		self.max_members = max_members
@@ -90,13 +85,12 @@ public struct Guild: GatewayData, Equatable, Identifiable {
 		self.welcome_screen = welcome_screen
 		self.nsfw_level = nsfw_level
 		self.stage_instances = stage_instances
-		self.stickers = stickers
-		self.guild_scheduled_events = guild_scheduled_events
+        self.guild_scheduled_events = guild_scheduled_events
 		self.premium_progress_bar_enabled = premium_progress_bar_enabled
 	}
 
     public static func == (lhs: Guild, rhs: Guild) -> Bool {
-        lhs.id == rhs.id && lhs.name == rhs.name && lhs.channels == rhs.channels
+        lhs.id == rhs.id && lhs.name == rhs.name
     }
 
     public let id: Snowflake
@@ -116,8 +110,6 @@ 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 roles: [DecodableThrowable<Role>]
-    public let emojis: [DecodableThrowable<Emoji>]
     public let features: [DecodableThrowable<GuildFeature>]
     public let mfa_level: MFALevel
     public let application_id: Snowflake? // For bot-created guilds
@@ -129,9 +121,6 @@ public struct Guild: GatewayData, Equatable, Identifiable {
     public var unavailable: Bool? // If guild is unavailable due to an outage
     public var member_count: Int?
     public var voice_states: [VoiceState]?
-    public var members: [Member]?
-    public var channels: [Channel]?
-    public var threads: [Channel]?
     public var presences: [PresenceUpdate]?
     public let max_presences: Int? // null is always returned, apart from the largest of guilds
     public let max_members: Int?
@@ -148,11 +137,35 @@ public struct Guild: GatewayData, Equatable, Identifiable {
     public let welcome_screen: GuildWelcomeScreen?
     public let nsfw_level: NSFWLevel
     public var stage_instances: [StageInstance]?
-    public let stickers: [Sticker]?
     public var guild_scheduled_events: [GuildScheduledEvent]?
     public let premium_progress_bar_enabled: Bool
 }
 
+/// Guild received in initial ready payload, contains more info than what can be found in ``Guild``
+///
+/// > Not all fields have been added below, only the required ones
+public struct PreloadedGuild: GatewayData, Identifiable, Equatable {
+    public static func == (lhs: PreloadedGuild, rhs: PreloadedGuild) -> Bool {
+        lhs.properties == rhs.properties && lhs.id == rhs.id
+    }
+
+    public let version: Int
+    public let channels: [Channel]
+    public let emojis: [DecodableThrowable<Emoji>]
+    public let id: Snowflake
+    public let joined_at: Date
+    public let large: Bool
+    public let lazy: Bool
+    public let member_count: Int
+
+    /// 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 threads:
+}
+
 // Partial Guild, returned when listing guilds
 public struct PartialGuild: Codable, GatewayData {
     public let id: Snowflake

Sources/DiscordKitCore/Objects/Data/Member.swift

@@ -20,4 +20,5 @@ public struct Member: Codable, GatewayData {
     public let permissions: String? // Total permissions of the member in the channel, including overwrites, returned when in the interaction object
     public let communication_disabled_until: Date? // When the user's timeout will expire and the user will be able to communicate in the guild again, null or a time in the past if the user is not timed out
     public let guild_id: Snowflake?
+    public let user_id: Snowflake? // Only present in merged_members in READY payload!
 }

Sources/DiscordKitCore/Objects/Gateway/DataStructs.swift

@@ -112,8 +112,13 @@ public struct SubscribeGuildEvts: OutgoingGatewayData {
 ///
 /// > Warning: This should only be sent in identify payloads for user accounts. Bot accounts don't need this!
 struct ClientState: OutgoingGatewayData {
-    let guild_hashes: GuildHashes
+    struct GuildVersion: OutgoingGatewayData { }
+
+    let api_code_version: Int
+    let guild_versions: GuildVersion
     let highest_last_message_id: Snowflake
+    let initial_guild_id: Snowflake?
+    let private_channels_version: String
     let read_state_version: Int
     let user_guild_settings_version: Int
     let user_settings_version: Int

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

@@ -13,14 +13,16 @@ public struct ReadyEvt: Decodable, GatewayData {
     public let v: Int
     public let user: CurrentUser
     public let users: [User]
-    public let guilds: [Guild]
+    public let guilds: [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 merged_members: [[Member]]
+
     /// The user's unreads
     ///
     /// > An implementation for unreads is still WIP in Swiftcord

Sources/DiscordKitCore/Objects/Gateway/GatewayIO.swift

@@ -213,11 +213,12 @@ public struct GatewayIncoming: Decodable {
             // Cue the long switch case to parse every single event
             switch type {
             case .ready:
-                if let userReady = try? values.decode(ReadyEvt.self, forKey: .data) {
+                /*if let userReady = try? values.decode(ReadyEvt.self, forKey: .data) {
                     data = .userReady(userReady)
                 } else {
                     data = .botReady(try values.decode(BotReadyEvt.self, forKey: .data))
-                }
+                }*/
+                data = .userReady(try values.decode(ReadyEvt.self, forKey: .data))
             case .readySupplemental: data = .readySupplemental(try values.decode(ReadySuppEvt.self, forKey: .data))
             case .resumed: data = .resumed