Mismatched entity and/or field definitions in contacts

I ran into this today. Any advice would be greatly appreciated. This occurred as part of a D9 upgrade, but I'm not entirely sure where the update flopped (I may have missed it in updating everything to latest D8) - my suspicion is that redhen.install is missing something.

Having just updated 5 redhen installs to D9 over the past month, this is still an issue. That being said, it hasnt stopped me or presented any problems just so far, so it has been a pretty low priority item.

I'm hoping to find some time in the next couple weeks to see where thee breakdown is and work up a patch.

It seems to me there was a missed/deleted update hook in one of the various version upgrades to this module?

[message deleted]

Ugh, that didn't work either (I forgot I'd deleted the contacts in my local test environment). Stuck at square one. How the hell do I get a working update to fix these f***ing fields?!?

This finally worked:

/**
 * Update name fields in RedHen Contact Entity Schema.
 */
function redhen_contact_update_8001() {
  $config = \Drupal::config('redhen_contact.settings');
  $required_names = $config->get('required_properties');
  $entity_type_manager = \Drupal::entityTypeManager();
  $bundle_of = 'redhen_contact';

  $storage = $entity_type_manager->getStorage($bundle_of);
  $bundle_definition = $entity_type_manager->getDefinition($bundle_of);
  // Sometimes the primary key isn't 'id'. e.g. 'eid' or 'item_id'.
  $id_key = $bundle_definition->getKey('id');
  // If there is no data table defined then use the base table.
  $table_name = $storage->getDataTable() ?: $storage->getBaseTable();
  $database = \Drupal::database();
  $definition_manager = \Drupal::entityDefinitionUpdateManager();

  $fields = [
    'first_name' => 'First Name',
    'middle_name' => 'Last Name',
    'last_name' => 'Middle Name',
  ];
  $field_keys = array_keys($fields);
  array_unshift($field_keys, $id_key);

  // Store the existing values.
  $name_values = $database->select($table_name)
    ->fields($table_name, $field_keys)
    ->execute()
    ->fetchAllAssoc($id_key, PDO::FETCH_ASSOC);

  // Clear out the values.
  $database->update($table_name)
    ->fields(array_fill_keys(array_keys($fields), NULL))
    ->execute();

  // Uninstall the fields.
  foreach ($fields as $field_name => $field_label) {
    $field_storage_definition = $definition_manager->getFieldStorageDefinition($field_name, $bundle_of);
    $definition_manager->uninstallFieldStorageDefinition($field_storage_definition);

    // Create a new field definition.
    $new_field = BaseFieldDefinition::create('string')
      ->setLabel(t($field_label))
      ->setSettings([
        'max_length' => 255,
        'text_processing' => 0,
      ])
      ->setDefaultValue('')
      ->setDisplayOptions('form', [
        'type' => 'string_textfield',
        'weight' => -10,
      ])
      ->setDisplayConfigurable('form', TRUE)
      ->setDisplayConfigurable('view', TRUE)
      ->setRequired($required_names[$field_name])
      ->setRevisionable(TRUE);

    // Install the new definitions.
    $definition_manager->installFieldStorageDefinition($field_name, $bundle_of, $bundle_of, $new_field);
  }

  // Restore the values.
  foreach ($name_values as $id => $value) {
    $field_values = [];
    foreach (array_keys($fields) as $key) {
      $field_values[$key] = $value[$key];
    }
    $database->update($table_name)
      ->fields($field_values)
      ->condition($id_key, $id)
      ->execute();
  }
}

Thanks, this is really handy!

The reason we didn't have a hook update was two factors: one was it seemed hard, as you have discovered, and the other is that the change was made back in alpha and... ya know, alpha isn't stable anyway. But this is really helpful.

I'm mildly concerned about timeouts on large databases, though, and I'm also concerned about running this on sites that have already made the change in some other way. For this reason, I think it would be better as a drush command.

Initial testing of #8 does in fact resolve the errors, but now none of my contacts have names. My initial guess is that its due to the number of records. i've got ~20k contacts.

Ok, drush command added. It'll be in the next release.

@gcb - I think this needs to be reopened. It turns out it's not updating the fields in the redhen_contacts_revision table.

Adding this at the end solved that:

    // Values need to be reinserted into revisions as well.
    $database->update($table_name . '_revision')
      ->fields($field_values)
      ->condition($id_key, $id)
      ->execute();

+1 for re-opening this and adding #15 to the end of the update hook

I think the main reason the message appeared in the status report is that the maxlength was changed in https://git.drupalcode.org/project/redhen/-/commit/2ed52ef4c775e0a18c111... without updating existing DBs.

Usually the definition_update_manager makes all the DB changes and no explicit DB commands are needed. AFAIK The typical place for these updates is a post_update hook - So I moved the script from the drush cmd too the hook and removed the manual DB actions.

@Harlor

Thx. proper solution for such updates.