vrchatapi 1.23.0

VRChat API Client for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

use vrchatapi::models::{GroupAuditLogEntry, PaginatedGroupAuditLogEntryList};

const PAGE: &str = r#"{
  "hasNext": true,
  "results": [
    {
      "actorDisplayName": "8cf3def6b8cea",
      "actorId": "usr_9439f8cc-1c6b-4dca-9a07-d2eccb570701",
      "created_at": "2026-10-07T20:26:01.359Z",
      "data": {
        "description": {
          "new": "Updated by the test suite",
          "old": "Created by the test suite"
        },
        "name": {
          "new": "test-renamed",
          "old": "test"
        }
      },
      "description": "Group role test updated by 8cf3def6b8cea.",
      "eventType": "group.role.update",
      "groupId": "grp_613f1c1c-ebb3-48d5-ad64-a7ef7a08d0bf",
      "id": "gaud_8ee24b40-6a20-4f19-9693-fa7ea0d79f51",
      "targetId": "grol_459e7601-f5a1-4aec-aa18-903adb1f6889"
    }
  ],
  "totalCount": 492
}"#;

const UNLISTED: &str = r#"{
  "actorDisplayName": "8cf3def6b8cea",
  "actorId": "usr_9439f8cc-1c6b-4dca-9a07-d2eccb570701",
  "created_at": "2026-10-07T20:26:01.359Z",
  "data": {
    "description": {
      "new": "Updated by the test suite",
      "old": "Created by the test suite"
    }
  },
  "description": "Group role test updated by 8cf3def6b8cea.",
  "eventType": "group.future.thing",
  "groupId": "grp_613f1c1c-ebb3-48d5-ad64-a7ef7a08d0bf",
  "id": "gaud_8ee24b40-6a20-4f19-9693-fa7ea0d79f51",
  "targetId": "grol_459e7601-f5a1-4aec-aa18-903adb1f6889"
}"#;

const MISTYPED_TARGET: &str = r#"{
  "actorDisplayName": "8cf3def6b8cea",
  "actorId": "usr_9439f8cc-1c6b-4dca-9a07-d2eccb570701",
  "created_at": "2026-10-07T20:26:01.359Z",
  "data": {
    "description": {
      "new": "Updated by the test suite",
      "old": "Created by the test suite"
    }
  },
  "description": "Group role test updated by 8cf3def6b8cea.",
  "eventType": "group.role.update",
  "groupId": "grp_613f1c1c-ebb3-48d5-ad64-a7ef7a08d0bf",
  "id": "gaud_8ee24b40-6a20-4f19-9693-fa7ea0d79f51",
  "targetId": 5
}"#;

fn entries() -> Vec<GroupAuditLogEntry> {
    let page: PaginatedGroupAuditLogEntryList = serde_json::from_str(PAGE).unwrap();
    page.results.unwrap()
}

#[test]
fn round_trips_a_captured_page() {
    let page: PaginatedGroupAuditLogEntryList = serde_json::from_str(PAGE).unwrap();
    let expected: serde_json::Value = serde_json::from_str(PAGE).unwrap();
    assert_eq!(serde_json::to_value(&page).unwrap(), expected);
}

#[test]
fn types_the_fields_of_a_role_update() {
    let GroupAuditLogEntry::GroupRoleUpdate(update) = entries().remove(0) else {
        panic!("expected a group.role.update entry");
    };
    assert_eq!(
        update.group_audit_log_entry_base.actor_display_name,
        "8cf3def6b8cea"
    );
    assert_eq!(
        update.target_id,
        "grol_459e7601-f5a1-4aec-aa18-903adb1f6889"
    );
    let name = update.data.name.unwrap();
    assert_eq!(
        (name.old.as_str(), name.new.as_str()),
        ("test", "test-renamed")
    );
    let description = update.data.description.unwrap();
    assert_eq!(
        (description.old.as_str(), description.new.as_str()),
        ("Created by the test suite", "Updated by the test suite"),
    );
}

#[test]
fn parses_an_unlisted_event_type_into_unknown() {
    let entry: GroupAuditLogEntry = serde_json::from_str(UNLISTED).unwrap();
    let GroupAuditLogEntry::GroupAuditLogEntryUnknown(unknown) = &entry else {
        panic!("expected the unknown variant, got {entry:?}");
    };
    assert_eq!(unknown.event_type, "group.future.thing");
    assert_eq!(
        unknown.target_id,
        "grol_459e7601-f5a1-4aec-aa18-903adb1f6889"
    );
    let expected: serde_json::Value = serde_json::from_str(UNLISTED).unwrap();
    assert_eq!(serde_json::to_value(&entry).unwrap(), expected);
}

#[test]
fn rejects_an_entry_no_member_accepts() {
    let error = serde_json::from_str::<GroupAuditLogEntry>(MISTYPED_TARGET).unwrap_err();
    assert_eq!(
        error.to_string(),
        "data did not match any variant of untagged enum GroupAuditLogEntry"
    );
}

#[test]
fn parses_a_listed_event_type_with_drifted_data_into_unknown() {
    let drifted = UNLISTED
        .replace("group.future.thing", "group.role.update")
        .replace("\"Updated by the test suite\"", "1");
    let entry: GroupAuditLogEntry = serde_json::from_str(&drifted).unwrap();
    let GroupAuditLogEntry::GroupAuditLogEntryUnknown(unknown) = &entry else {
        panic!("expected the unknown variant, got {entry:?}");
    };
    assert_eq!(unknown.event_type, "group.role.update");
    let expected: serde_json::Value = serde_json::from_str(&drifted).unwrap();
    assert_eq!(serde_json::to_value(&entry).unwrap(), expected);
}