Custom field type that has an array property won't save unless serialized, otherwise get "This value should be of the correct primitive type" error

Question

I have a custom field type with two properties I am storing on it. One stores a string. The other I want to store an array. The array should be serialized in the field value table of the database, but it should be an array when exported to YAML (default value setting of the field instance configuration).

I am having trouble getting this to work. In my head it would be similar to 'allowed formats' option on text long instances.

The field value schema:

field.value.myfieldtype:
  type: mapping
  label: Default value
  mapping:
    view_id:
      type: string
      label: View ID
    facets:
      type: sequence
      label: Facet list
      sequence:
        type: string
        label: 'Facet machine name'

The field properties are defined as:

  /**
   * {@inheritdoc}
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {

    $properties['view_id'] = DataDefinition::create('string')
      ->setLabel(t('A Drupal View.'))
      ->setRequired(TRUE);

    $properties['facets'] = DataDefinition::create('string')
      ->setLabel(t('A list of facets selected by the user.'))
      ->setRequired(FALSE);

    return $properties;
  }

In the custom form widget I made, I have massageFormValues like this:

  /**
   * {@inheritdoc}
   */
  public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {
    $facet_list = !empty($values[0]['facets']) ? array_filter($values[0]['facets']) : [];
    $values[0]['facets'] = serialize($facet_list);
    return parent::massageFormValues($values, $form, $form_state);
  } 

If I call array_keys instead of serialize, or pass anything that is not a string, I get an error on save:

This value should be of the correct primitive type. 

If I use serialize, it saves fine and I can see the serialized value in the tuple in the database. However, if I set a 'Default Value' on the field instance and run a configuration export, I get this:

default_value:
  -
    view_id: 'search:content_listing'
    facets: 'a:1:{s:16:"content_category";s:16:"content_category";}'

What I would expect is:

default_value:
  -
    view_id: 'search:content_listing'
    facets: 
      - content_category
      - (other selected options)
      - (other selected options)

What am I missing?

Answer 1

Instead of serializing, I changed the schema of the property to store as JSON for sake of the storage and export since serialized strings are discouraged.