Add unit tests for size of custom IPC packets

-Via this test I also found the size of RequestCreateCharacter was incorrect!

Author: thedax

resources/data/opcodes.json

@@ -863,7 +863,7 @@
             "name": "RequestCreateCharacter",
             "comment": "Request the world server to create a character",
             "opcode": 1,
-            "size": 1060
+            "size": 1064
         },
         {
             "name": "CharacterCreated",
@@ -902,7 +902,7 @@
             "size": 8
         },
         {
-            "name": "RequestCharacterListRepsonse",
+            "name": "RequestCharacterListResponse",
             "comment": "Response to RequestCharacterList",
             "opcode": 8,
             "size": 9473

src/ipc/kawari/mod.rs

@@ -54,7 +54,7 @@ pub enum CustomIpcData {
     RequestCharacterList {
         service_account_id: u64,
     },
-    RequestCharacterListRepsonse {
+    RequestCharacterListResponse {
         #[bw(calc = characters.len() as u8)]
         num_characters: u8,
         #[br(count = num_characters)]
@@ -116,3 +116,95 @@ impl Default for CustomIpcData {
         }
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use std::io::Cursor;
+
+    use binrw::BinWrite;
+
+    use crate::packet::{IpcSegmentHeader, ReadWriteIpcOpcode, ReadWriteIpcSegment};
+
+    use super::*;
+
+    /// Ensure that the IPC data size as reported matches up with what we write
+    #[test]
+    fn custom_ipc_sizes() {
+        let ipc_types = [
+            CustomIpcData::RequestCreateCharacter {
+                service_account_id: 0,
+                name: "".to_string(),
+                chara_make_json: "".to_string(),
+            },
+            CustomIpcData::CharacterCreated {
+                actor_id: 0,
+                content_id: 0,
+            },
+            CustomIpcData::GetActorId {
+                content_id: 0,
+            },
+            CustomIpcData::ActorIdFound {
+                actor_id: 0,
+            },
+            CustomIpcData::CheckNameIsAvailable {
+                name: "".to_string(),
+            },
+            CustomIpcData::NameIsAvailableResponse {
+                free: false,
+            },
+            CustomIpcData::RequestCharacterList {
+                service_account_id: 0,
+            },
+            CustomIpcData::RequestCharacterListResponse {
+                characters: vec![CharacterDetails::default(); 8],
+            },
+            CustomIpcData::DeleteCharacter {
+                content_id: 0,
+            },
+            CustomIpcData::CharacterDeleted {
+                deleted: 0,
+            },
+            CustomIpcData::ImportCharacter {
+                service_account_id: 0,
+                path: "".to_string(),
+            },
+            CustomIpcData::RemakeCharacter {
+                content_id: 0,
+                chara_make_json: "".to_string(),
+            },
+            CustomIpcData::CharacterRemade {
+                content_id: 0,
+            },
+            CustomIpcData::CharacterImported {
+                message: "".to_string(),
+            },
+            CustomIpcData::DeleteServiceAccount {
+                service_account_id: 0,
+            },
+            CustomIpcData::RequestFullCharacterList {}, // Included here for completeness despite the 0 size
+            CustomIpcData::FullCharacterListResponse {
+                json: "".to_string(),
+            },
+        ];
+
+        for data in &ipc_types {
+            let mut cursor = Cursor::new(Vec::new());
+
+            let opcode: CustomIpcType = ReadWriteIpcOpcode::from_data(data);
+            let ipc_segment = CustomIpcSegment {
+                header: IpcSegmentHeader::from_opcode(opcode.clone()),
+                data: data.clone(),
+                ..Default::default()
+            };
+            ipc_segment.write_le(&mut cursor).unwrap();
+
+            let buffer = cursor.into_inner();
+
+            assert_eq!(
+                buffer.len(),
+                ipc_segment.calc_size() as usize,
+                "{opcode:#?} did not match size!"
+            );
+        }
+    }
+}

src/lobby/connection.rs

@@ -155,7 +155,7 @@ impl LobbyConnection {
             let name_response = send_custom_world_packet(charlist_request)
                 .await
                 .expect("Failed to get name request packet!");
-            let CustomIpcData::RequestCharacterListRepsonse { characters } = &name_response.data
+            let CustomIpcData::RequestCharacterListResponse { characters } = &name_response.data
             else {
                 panic!("Unexpedted custom IPC type!")
             };

src/world/custom_ipc_connection.rs

@@ -168,7 +168,7 @@ impl CustomIpcConnection {
                     self.send_custom_response(PacketSegment {
                         segment_type: SegmentType::KawariIpc,
                         data: SegmentData::KawariIpc(CustomIpcSegment::new(
-                            CustomIpcData::RequestCharacterListRepsonse { characters },
+                            CustomIpcData::RequestCharacterListResponse { characters },
                         )),
                         ..Default::default()
                     })