Follow-up to #2002134: Move TypedData metadata introspection from data objects to definition objects. Let's implement getting property definitions in the EntityDefinition class to cover the case of multiple defined bundles.

CommentFileSizeAuthor
#25 Screenshot 2025-10-31 at 5.34.45 PM.png590.93 KBwim leers

Comments

berdir’s picture

berdir
Primary language German
Location Switzerland
commented
Status: Postponed » Active

And how should that work exactly?

Definitions can vary by bundle, so which one do we prefer?

fubhy’s picture

fubhy commented

I just ran across this problem while working on the GraphQL module trying to generate the Schema for entities and their bundles. Multiple bundles would make that REALLY awkward. I have no clue how that could possibly work.

Version: 8.0.x-dev » 8.1.x-dev

Drupal 8.0.6 was released on April 6 and is the final bugfix release for the Drupal 8.0.x series. Drupal 8.0.x will not receive any further development aside from security fixes. Drupal 8.1.0-rc1 is now available and sites should prepare to update to 8.1.0.

Bug reports should be targeted against the 8.1.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.2.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.1.x-dev » 8.2.x-dev

Drupal 8.1.9 was released on September 7 and is the final bugfix release for the Drupal 8.1.x series. Drupal 8.1.x will not receive any further development aside from security fixes. Drupal 8.2.0-rc1 is now available and sites should prepare to upgrade to 8.2.0.

Bug reports should be targeted against the 8.2.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.3.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.2.x-dev » 8.3.x-dev

Drupal 8.2.6 was released on February 1, 2017 and is the final full bugfix release for the Drupal 8.2.x series. Drupal 8.2.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.3.0 on April 5, 2017. (Drupal 8.3.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.3.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.4.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.3.x-dev » 8.4.x-dev

Drupal 8.3.6 was released on August 2, 2017 and is the final full bugfix release for the Drupal 8.3.x series. Drupal 8.3.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.4.0 on October 4, 2017. (Drupal 8.4.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.4.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented
Priority: Normal » Major
Issue tags: +API-First Initiative

Not only GraphQL is affected, also JSON API. Without this, EntityDataDefinition is basically useless.

berdir’s picture

berdir
Primary language German
Location Switzerland
commented

I still don't quite understand what exactly this is trying to achieve. As I said, the same field can for example have a different label or different field settings for different bundles. What would you want to display then? What is this needed for?

gabesullice’s picture

gabesullice
Primary language English
commented

@Berdir, speaking for the JSON API module: we operate on all fields (updating and normalizing) using the TypedData API. Generally, this would let us deal with both entities and fields more uniformly.

Specifically, this issue was brought back up because we would like to use DataDefinitionInterface::isInternal() for limiting access to "internal" entities rather than multiple implementations of module-specific hooks.

WRT bundle-specific fields, Drupal\Core\Entity\Plugin\DataType\Deriver\EntityDeriver derives types by bundle, with a data type like: entity:node:article.

berdir’s picture

berdir
Primary language German
Location Switzerland
commented

I see, but afaik having isInternal() support on the entity-type level has nothing to do with this issue. As far as I understand, this is about having a single definition somehow for configurable fields across multiple bundle, but as I said, I don't really see how that would work or why it is major.

I'd suggest to open a separate issue for the isInternal() thing.

wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented
Related issues: +#2932035: ResourceTypes should be internal when EntityType::isInternal is TRUE

See #2932035-17: ResourceTypes should be internal when EntityType::isInternal is TRUE by @gabesullice.

wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented
Issue tags: +Needs title update, +Needs issue summary update

As far as I understand, this is about having a single definition somehow for configurable fields across multiple bundle, but as I said, I don't really see how that would work or why it is major.

I guess it's not clear what this issue is about exactly. So let's fix that.

gabesullice’s picture

gabesullice
Primary language English
commented
Title: Support deriving fields from entity definitions with multiple bundles » EntityDataDefinition::create() does not respect derived entity definitions
Version: 8.4.x-dev » 8.5.x-dev
Category: Task » Bug report
Issue summary: View changes
Issue tags: -Needs title update, -Needs issue summary update
Related issues: +#2936714: Entity type definitions cannot be set as 'internal'

Updated the IS and issue title.

berdir’s picture

berdir
Primary language German
Location Switzerland
commented

I still don't think that's the same issue and a separate new issue would make more sense to me.

gabesullice’s picture

gabesullice
Primary language English
commented
Title: EntityDataDefinition::create() does not respect derived entity definitions » Support deriving fields from entity definitions with multiple bundles
Version: 8.5.x-dev » 8.4.x-dev
Category: Bug report » Task
Issue summary: View changes
Issue tags: -API-First Initiative
Related issues: -#2936714: Entity type definitions cannot be set as 'internal' +#2936725: EntityDataDefinition::create() does not respect derived entity definitions

Fair enough, reverted IS and title.

New issue: #2936725: EntityDataDefinition::create() does not respect derived entity definitions

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.4 was released on January 3, 2018 and is the final full bugfix release for the Drupal 8.4.x series. Drupal 8.4.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.5.0 on March 7, 2018. (Drupal 8.5.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.5.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.5.x-dev » 8.6.x-dev

Drupal 8.5.6 was released on August 1, 2018 and is the final bugfix release for the Drupal 8.5.x series. Drupal 8.5.x will not receive any further development aside from security fixes. Sites should prepare to update to 8.6.0 on September 5, 2018. (Drupal 8.6.0-rc1 is available for testing.)

Bug reports should be targeted against the 8.6.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.6.x-dev » 8.8.x-dev

Drupal 8.6.x will not receive any further development aside from security fixes. Bug reports should be targeted against the 8.8.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.9.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.7 was released on June 3, 2020 and is the final full bugfix release for the Drupal 8.8.x series. Drupal 8.8.x will not receive any further development aside from security fixes. Sites should prepare to update to Drupal 8.9.0 or Drupal 9.0.0 for ongoing support.

Bug reports should be targeted against the 8.9.x-dev branch from now on, and new development or disruptive changes should be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.2.x-dev

Drupal 8 is end-of-life as of November 17, 2021. There will not be further changes made to Drupal 8. Bugfixes are now made to the 9.3.x and higher branches only. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.15 was released on June 1st, 2022 and is the final full bugfix release for the Drupal 9.3.x series. Drupal 9.3.x will not receive any further development aside from security fixes. Drupal 9 bug reports should be targeted for the 9.4.x-dev branch from now on, and new development or disruptive changes should be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.9 was released on December 7, 2022 and is the final full bugfix release for the Drupal 9.4.x series. Drupal 9.4.x will not receive any further development aside from security fixes. Drupal 9 bug reports should be targeted for the 9.5.x-dev branch from now on, and new development or disruptive changes should be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.5.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented
Title: Support deriving fields from entity definitions with multiple bundles » Support deriving fields from entity definitions with multiple bundles (or zero bundles)
Issue tags: +Contributed project blocker, +Experience Builder
StatusFileSize
new Screenshot 2025-10-31 at 5.34.45 PM.png590.93 KB

The same problem occurs for entity types with zero bundles, such as User.

Using a Node's uid field's field definition, to then get the entity property definition, results in none of the configurable fields on the User to be found. That's because the entity's ::getTargetDefinition() returns

EntityDataDefinition::create('user')

(i.e. no bundles set, which is correct)

Which then is the other way of triggering the same bug previously reported here: \Drupal\Core\Entity\TypedData\EntityDataDefinition::getPropertyDefinitions() does:

  public function getPropertyDefinitions() {
…
          // @todo Add support for handling multiple bundles.
          // See https://www.drupal.org/node/2169813.
          $bundles = $this->getBundles();
          if (is_array($bundles) && count($bundles) == 1) {
            $this->propertyDefinitions = \Drupal::service('entity_field.manager')->getFieldDefinitions($entity_type_id, reset($bundles));
          }
          else {
            $this->propertyDefinitions = \Drupal::service('entity_field.manager')->getBaseFieldDefinitions($entity_type_id);
          }
…
    return $this->propertyDefinitions;
  }

which hits the else-branch because $bundles === NULL, and hence it explicitly calls ::getBaseFieldDefinitions(). 😭

wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented

Fix: https://git.drupalcode.org/project/canvas/-/merge_requests/242/diffs?com...

berdir’s picture

berdir
Primary language German
Location Switzerland
commented

If a an entity type has no bundles then the bundle is the entity type. For user, that is user. That means ->getFieldDefinitions('user', 'user')
See \Drupal\Core\Entity\EntityTypeBundleInfo::getAllBundleInfo() and \Drupal\Core\Entity\ContentEntityBase::__construct().

You can also see this in \Drupal\Core\Entity\Plugin\DataType\EntityAdapter::createFromEntity(). bundle is always set.

I'm not sure where EntityDataDefinition::create('user') is called as opposed to EntityDataDefinition::create('user', 'user').

We could add a special case to fall back to that but I think it's up to the caller to set the bundle in this case, same as EntityAdapter.

I can only repeat what I've been doing for 10 years, multiple bundles and no bundle (which isn't really a thing as there is always one bundle) is very different and shouldn't be mixed up in the same issue.

Version: 11.x-dev » main

Drupal core is now using the main branch as the primary development branch. New developments and disruptive changes should now be targeted to the main branch.

Read more in the announcement.