Add Data Producer plugins for creating, updating and deleting entities. #1212

Sam152 · 2021-06-10T09:46:43Z

I have a site with a number of entity types that are linked to mutations for a fairly standard set of CRUD operations. One thing I found that was missing from the module was a fairly generic set of create/update/delete data producers. I built some, which I have been using which are entity type agnostic, so submitting as a PR in case they are useful upstream.

I'm not sure if this fits in with the ethos of module, which seems focused on empowering folks to connect schema to plain PHP entry points, where they can interface with Drupal entities (or anything else) however they like - directly, but I think these could potentially cover a few blindspots that folks often miss, like entity validation or field access. With the number of entity types I was required to put together, I think writing code for each one individually, without an abstraction, to validate access, fields etc. would have been a bit impractical.

Here are some simplified examples of how I've integrated them into my project, but the builder object seems flexible enough that you could mix and match these producers in various ways.

Creating an entity called article:

    $registry->addFieldResolver('Mutation', 'create_article',
      $builder->produce('create_entity')
        ->map('values', $builder->fromArgument('data'))
        ->map('entity_type', $builder->fromValue('article'))
        ->map('entity_return_key', $builder->fromValue('article'))
    );

Updating it:

$registry->addFieldResolver('Mutation', 'update_article',
      $builder->produce('update_entity')
        ->map('values', $builder->fromArgument('data'))
        ->map('entity_return_key', $builder->fromValue('article'))
        ->map(
          'entity',
          $builder->produce('entity_load')
            ->map('access', $builder->fromValue(FALSE))
            ->map('type', $builder->fromValue($entity_type_id))
            ->map('id', $builder
              ->produce('access_array')
              ->map('input', $builder->fromArgument('data'))
              ->map('key', $builder->fromValue('id'))
            )
        )
    );

A specific mutation to publish an entity:

    $registry->addFieldResolver('Mutation', 'publish_article',
      $builder->produce('update_entity')
        ->map('values', $builder->fromValue([
          'published' => TRUE,
        ]))
        ->map('entity_return_key', $builder->fromValue('article'))
        ->map(
          'entity',
          $builder->produce('entity_load')
            ->map('access', $builder->fromValue(FALSE))
            ->map('type', $builder->fromValue('article'))
            ->map('id', $builder
              ->produce('access_array')
              ->map('input', $builder->fromArgument('data'))
              ->map('key', $builder->fromValue('id'))
            )
        )
    );

A delete:

$registry->addFieldResolver('Mutation', 'delete_article',
      $builder->produce('delete_entity')
        ->map(
          'entity',
          $builder->produce('entity_load')
            ->map('access', $builder->fromValue(FALSE))
            ->map('type', $builder->fromValue('article'))
            ->map('id', $builder
              ->produce('access_array')
              ->map('input', $builder->fromArgument('data'))
              ->map('key', $builder->fromValue('id'))
            )
        )
    );

The schema:

    input OperationInput {
        id: ID!
    }
    type OperationMutationResponse {
        was_successful: Boolean!
        errors: [Violation!]
    }
    input CreateArticleInput {
        use_case: ID!
        name: String!
        body: String!
        published: Boolean
    }
    input UpdateArticleInput {
        id: ID!
        name: String
        body: String
        published: Boolean
    }
    
    type ArticleMutationResponse {
        article: Article
        errors: [Violation!]
    }

    create_article(data: CreateArticleInput): ArticleMutationResponse
    update_article(data: UpdateArticleInput): ArticleMutationResponse
    publish_article(data: OperationInput): OperationMutationResponse
    delete_article(data: OperationInput): OperationMutationResponse

joaogarin · 2021-06-10T15:08:31Z

this sounds awsome 🎉 =) ? cc @klausi @rthideaway

klausi

Oh nice, phenomenal work! This is pretty mature already, great! Yes, we would very much appreciate some out of the box data producer mutations for content entities :)

I think I saw one security issue with missing field access checks on entity creation and I have a bunch of other thoughts added here. But don't let this discourage you, I think 80% of work is done here and we just need to tweak this a bit.

Another important aspect of this is documentation. The schema mapping examples you did are quite good, but they are also complicated. I had to read them a couple of times to remember how this all worked, so this will be even harder for newbies. We should follow up with a very concrete docs update after this is finished, using the examples that you already provided here.

Thanks a lot!

klausi · 2021-06-12T11:54:57Z