Contrib.social

Install hook causes error when installing from config

Open on Drupal.org →
Created on 30 March 2024, about 1 year ago

Problem/Motivation

The install hook for this module appears to cause problems when installing using existing configuration. I haven't seen the problem when using the module normally, but when installing from config (as part of a unit testing run) the module throws the following error.

[error]  Error: Call to a member function revokePermission() on null in user_role_revoke_permissions() (line 1023 of /var/www/html/docroot/core/modules/user/user.module) #0 /var/www/html/docroot/core/modules/user/user.module(983): user_role_revoke_permissions('authenticated', Array)
#1 /var/www/html/docroot/modules/contrib/protected_forms/protected_forms.install(15): user_role_change_permissions('authenticated', Array)
#2 [internal function]: protected_forms_install(true)

Steps to reproduce

Install the module onto a site and export the configuration. Then use the following Drush command to install the site using that configuration.

drush si minimal --existing-config --yes --account-name=admin --account-pass=admin

Note that the standard install profile doesn't allow installing from config, which is why I used minimal here. Normally, I create a custom install profile and use that.

Proposed resolution

I managed to solve the problem I was having using the $is_syncing flag to bypass this hook since the configuration already holds this state.

function protected_forms_install($is_syncing) {
  if (!$is_syncing) {
    user_role_change_permissions(RoleInterface::AUTHENTICATED_ID, [
      'bypass protected forms validation' => FALSE,
    ]);
  }
}

The problem, however, is that I'm not quite sure what this hook is doing. I can see that it's setting the bypass protected forms validation permission to false for authenticated users, but isn't this the default state for permissions? Is it worth removing the hook entirely?

Remaining tasks

Confirm if the hook is needed and remove it if not. If it is required then I'll create a merge request with the $is_syncing override.

🐛 Bug report
Status

Active

Version

2.0

Component

Code

Created by

🇬🇧United Kingdom philipnorton42 Cheshire

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024