Loss of stored data when multiple profiles are displayed as a form on account form [#3315270]

Problem

When multiple profiles per user are allowed, and the profile form is displayed on the user account form, the first profile is displayed multiple times and any changes made overwrite the data from the first profile, causing a loss of stored data.

Steps to reproduce

- Define a Profile Type (let's call it "Pet") with text field "Name"
- Select the option to "Allow multiple profiles per user"
- Under Configuration / People / Account Settings / Manage form display, enable the display of "Pet Profiles" and set the widget to "Profile Form".
- Add two Pet profiles to a particular user, say "Rover" and "Killer".
- Edit that user. Notice that 3 profile forms are displayed, all with "Rover". Change the third one to "Frank".
- Observe that Rover is now Frank and Killer is unchanged.

Proposed resolution

I believe the root of this problem is that the form state contains an array of profiles, indexed by profile type. Thus only the data from one profile of a given type is stored.

Remaining tasks

Fix the bug.

User interface changes

None

API changes

Unknown. The internal structure of the profiles in the form state may need to change.

Data model changes

None.

I reluctantly assigned the Priority of Critical because this bug causes a loss of stored data when the form is submitted. It can be reasonably argued that the circumstances that are needed to exhibit the bug are sufficiently uncommon that a lower priority such as major is appropriate.

Comment	File	Size	Author
#6	profile-edit_multiple-3315270-6.patch	3.48 KB	DanChadwick
#3	interdiff_2_3.txt	2.8 KB	tBKoT
#3	3315270-profile-edit-multiple-3.patch	4.25 KB	tBKoT
#2	profile-edit_multiple-3315270-2.patch	3.46 KB	DanChadwick

Issue fork profile-3315270

Show commands

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

Add & fetch this issue fork’s repository

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

Add & fetch this issue fork’s repository

3315270-multiple-profile-edit changes, plain diff MR !23
Check out this branch

About issue forks

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

14 October 2022 at 01:52

DanChadwick created an issue. See original summary.

Comment #2

DanChadwick CreditAttribution: DanChadwick commented 16 November 2022 at 15:19

Status:	Active	» Needs review
Issue tags:		+API change, +Needs change record

File	Size
profile-edit_multiple-3315270-2.patch	3.46 KB

This patch changes the storage of the profiles in the form state from an array of profiles indexed by profile type to an associative array (indexed by profile type) of arrays (indexed by delta) of profiles. This would be a backward-breaking change if any custom module relies on the storage of the profiles in the form state.

Comment #3

tBKoT CreditAttribution: tBKoT at Lemberg Solutions commented 29 March 2023 at 15:30

File	Size
3315270-profile-edit-multiple-3.patch	4.25 KB
interdiff_2_3.txt	2.8 KB

The patch from #2 is almost working for me. The issue I'm facing after applying it is that whenever we edit user info and save changes a new empty profile is created. So I added a condition to remove empty profiles from the form state, it works only for new items.

Comment #4

DanChadwick CreditAttribution: DanChadwick as a volunteer commented 23 February 2024 at 12:49

Neither #2 nor #3 apply to 1.8. In reviewing #3, I feel this is a distinct issue -- should new empty profiles be saved? This applies both to single and multiple profile entity references. I suggest @tBKoT create a new issue. First question is do you simply not save new empty profiles, or do you delete existing profiles which became empty. I would advocate the latter, but this is a change in behavior. This could be accomplished with something like:

      $empty_profile = $this->entityTypeManager->getStorage('profile')->create(['type' => $profile_type]);
      $profiles = array_filter($profiles, fn (ProfileInterface $profile) => $profile->equalToProfile($empty_profile));
<code>
This could be placed in <code>extractFormValues

, but might be better in saveProfiles.

Since patch-based testing is being discontinued, I will open an issue fork for a re-roll of #2.

Comment #5

DanChadwick CreditAttribution: DanChadwick as a volunteer commented 23 February 2024 at 12:49

Status:

Needs review

» Needs work

Comment #6

DanChadwick CreditAttribution: DanChadwick as a volunteer commented 23 February 2024 at 17:56

Status:

Needs work

» Needs review

File	Size
profile-edit_multiple-3315270-6.patch	3.48 KB

Reroll of #2, leaving the empty profile changes of #3 to a to-be-created separate issue. Patch for convenience of composer workflow.

Comment #7

23 February 2024 at 17:57

DanChadwick opened merge request !23

Comment #8

DanChadwick CreditAttribution: DanChadwick as a volunteer commented 25 February 2024 at 13:00

Catch 22. Drupal 9 support ended November 1st. The latest version of Drupal 9 required PHP 7.4, which includes support for arrow functions, which I used in this patch. But I cannot start a test with PHP 7.4 without using Drupal 10, which requires a composer.json file. So either I need to remove the arrow function just to make the linting pass, or we need to make profile be Drupal 10 testing compatible.

Comment #9

18 March 2024 at 13:17

jsacksick committed 8cb44eb1 on 8.x-1.x

Issue #3315270 by DanChadwick, tBKoT: Loss of stored data when multiple...

Comment #10

jsacksick CreditAttribution: jsacksick at Centarro commented 18 March 2024 at 13:25

Status:

Needs review

» Fixed

I committed your patch. If you're in the mood for writing a change record, that'd be great... Added the following note to the release notes for now:

As part of #3315270, the storage of the profiles in the form state changed from an array of profiles indexed by profile type to an associative array (indexed by profile type) of arrays (indexed by delta) of profiles.

Comment #11

DanChadwick CreditAttribution: DanChadwick as a volunteer commented 21 March 2024 at 00:17

Issue tags:

-Needs change record

Draft change record created.

Comment #12

drupalfan2 CreditAttribution: drupalfan2 as a volunteer commented 3 April 2024 at 09:55

After upgrading from profile 1.8 to 1.9 I get this error message:

Error: Class "Drupal\profile\ProfileType" not found in Drupal\profile\ProfileListBuilder->getDefaultOperations() (line 120 of modules/contrib/profile/src/ProfileListBuilder.php).
Drupal\Core\Entity\EntityListBuilder->getOperations() (Line: 212)
Drupal\Core\Entity\EntityListBuilder->buildOperations() (Line: 194)
Drupal\Core\Entity\EntityListBuilder->buildRow() (Line: 112)
Drupal\profile\ProfileListBuilder->buildRow() (Line: 242)
Drupal\Core\Entity\EntityListBuilder->render() (Line: 23)
Drupal\Core\Entity\Controller\EntityListController->listing()
call_user_func_array() (Line: 123)
Drupal\Core\EventSubscriber\EarlyRenderingControllerWrapperSubscriber->Drupal\Core\EventSubscriber\{closure}() (Line: 627)
Drupal\Core\Render\Renderer->executeInRenderContext() (Line: 121)
Drupal\Core\EventSubscriber\EarlyRenderingControllerWrapperSubscriber->wrapControllerExecutionInRenderContext() (Line: 97)
Drupal\Core\EventSubscriber\EarlyRenderingControllerWrapperSubscriber->Drupal\Core\EventSubscriber\{closure}() (Line: 181)
Symfony\Component\HttpKernel\HttpKernel->handleRaw() (Line: 76)
Symfony\Component\HttpKernel\HttpKernel->handle() (Line: 58)
Drupal\Core\StackMiddleware\Session->handle() (Line: 48)
Drupal\Core\StackMiddleware\KernelPreHandle->handle() (Line: 28)
Drupal\Core\StackMiddleware\ContentLength->handle() (Line: 32)
Drupal\big_pipe\StackMiddleware\ContentLength->handle() (Line: 106)
Drupal\page_cache\StackMiddleware\PageCache->pass() (Line: 85)
Drupal\page_cache\StackMiddleware\PageCache->handle() (Line: 48)
Drupal\Core\StackMiddleware\ReverseProxyMiddleware->handle() (Line: 51)
Drupal\Core\StackMiddleware\NegotiationMiddleware->handle() (Line: 36)
Drupal\Core\StackMiddleware\AjaxPageState->handle() (Line: 51)
Drupal\Core\StackMiddleware\StackedHttpKernel->handle() (Line: 704)
Drupal\Core\DrupalKernel->handle() (Line: 19)

Same problem with profile 1.10.

I do not allow multiple profiles per user, "Allow multiple profiles per user" is off.

And patch #16 of https://www.drupal.org/project/profile/issues/2599014 does not apply anymore.

I need a solution to get profile 1.9 and 1.10 running.