Problem/Motivation

Workspace config (wse_config) enables us to change config entities inside a workspace and to deploy them. However in order to actually enable this for any entity type, we still need to write code inside hook_entity_type_alter() to mark config entity types as internal and thus make CRUD operations for a type work inside a workspace.

If we don't do so, core's EntityOperations::shouldSkipPreOperations prevents us from using any config entity type that isn't marked as "internal".

Steps to reproduce

On Vanilla Drupal 9

  1. Enable wse_config
  2. Switch to the stage workspace
  3. Navigate to /admin/structure/block and try adding a block
  4. Workspaces will block this with an exception "This entity can only be saved in the default workspace."

Proposed resolution

Expose the relevant (some need to be excluded) config entity types on the settings form in a multi select. Then implement hook_entity_type_alter() to mark the types selected on the settings form as internal.

Issue fork wse-3293758

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

s_leu created an issue. See original summary.

s_leu opened merge request !27

s_leu’s picture

s_leu commented
Status: Active » Needs review
amateescu’s picture

amateescu commented
Title: Enable config entity types for workspace config on settings form » Add a way to configure allowed entity types for workspace-specific config

amateescu’s picture

amateescu commented
Status: Needs review » Fixed

Merged into 1.0.x, thanks!

s_leu opened merge request !28

s_leu’s picture

s_leu commented
Status: Fixed » Needs review

There's one small issue here: Once the settings are saved, the changes aren't in effect yet as entity definitions are cached in the discovery cache bin, thus we need to clear that cache when this setting is changed in order to get the changes to work right after submitting the settings form.

amateescu’s picture

amateescu commented
Status: Needs review » Fixed

Merged the followup :)

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.

amateescu’s picture

amateescu commented
Component: Code » Workspace Config
Issue tags: -Workspace config
mvnovick’s picture

mvnovick commented

There is still a problem with the linkcheckerlink config entity type which is used by the Link Checker module. When a workspace is active, and a node with a link in an HTML text field is being saved, the following error occurs:

Drupal\Core\Entity\EntityStorageException: The "linkcheckerlink" entity type can only be saved in the default workspace. in Drupal\Core\Entity\Sql\SqlContentEntityStorage->save() (line 817 of core/lib/Drupal/Core/Entity/Sql/SqlContentEntityStorage.php).

The linkcheckerlink config entity type needs to be added to the list of option is the Enabled config entity types multi-select field in the Workspace Settings page. I was able to get around this error by marking linkcheckerlink config entity type as "internal" inside hook_entity_type_build():

function my_module_entity_type_build(array &$entity_types) {
  $entity_type_id = 'linkcheckerlink';
 
  if (isset($entity_types[$entity_type_id]) && $entity_types[$entity_type_id] instanceof EntityTypeInterface) {
    /** @var \Drupal\Core\Entity\EntityTypeInterface $entity_type */
    $entity_type = $entity_types[$entity_type_id];
 
    // Mark the entity type as internal.
    $entity_type->set('internal', TRUE);
  }
}