User#_onUpdate is hard-coded to construct User documents from core class

[aaclayton]

Originally in GitLab by @stwlam

Environment Details

• Foundry VTT Version: 0.8.9
• Operating System: Linux (Ubuntu 20.10)
• How Are You Using Foundry: Native Application (Electron)
• Which Game System: pf2e (or any system which has a registered User subclass
• Modules Enabled?: random assortment

Issue Description

This one is only explody when a user is kicked:

        callback: li => {
          const user = game.users.get(li[0].dataset.userId);
          const role = user.role;
          user.update({role: CONST.USER_ROLES.NONE}).then(u => u.update({role}));
          ui.notifications.info(`${user.name} has been kicked from the world.`);
        }

When User#_onUpdate is called:

  /** @inheritdoc  */
  _onUpdate(data, options, userId) {
    super._onUpdate(data, options, userId);

    // If the user role changed, we need to re-build the immutable User object
    if ( this.data.role !== this.role ) {
      const user = new User(this.data); // 😰
      game.users.remove(user.id);
      game.users.insert(user);  // 😱

The second update from the context menu callback is never reached:

  /** @inheritdoc */
  set(id, document) {
    const cls = this.documentClass; // <-- UserPF2e
    if (!(document instanceof cls)) { // 🤯
      throw new Error(`You may only push instances of ${cls.documentName} to the ${this.name} collection`);
    }
    return super.set(document.id, document);
  }

[aaclayton]

of course pf2e would have a custom User class! I'm not shocked at all!

[aaclayton]

Originally in GitLab by @stwlam

We were plugging in a bunch of others around it, and CONFIG.User.documentClass was just sitting there looking back at us. :slight_frown: