Error on the add encryption profile form when Web Profiler module is installed

This change seems reasonable, especially because it guarantees we will get an array, but when I tested with webprofiler 10.1.8 and encrypt 3.1.1 on core 10.2.6, I was unable to reproduce the original error.

Merged in the latest changes so that we can run the GitLab CI tests on this.

andrew.farquharson → made their first commit to this issue’s fork.

@davisben @ptmkenny @rlhawk

#13 'When creating a new profile, there is no encryption method selected yet, so encryption_method_configuration will be null' A new e.g. functional test that creates a new profile with 'encryption_method_configuration' set to null that currently fails but that the merge(s) make pass could be created if necessary..

If the empty array allowed in the latest MR results in an empty 'encryption method' form select element then this would seem to be a problem as far as adding a new encryption profile entity via the form since the element is required: it cannot be left empty?

Maybe an exception should be thrown stating that the user may need to disable eg the webprofiler module before adding any new EP's.

Then a failing test can be created to test for the exception if an empty array is returned. The MR will make the test pass.

@davisben I will try to recreate and test your MR. But it would be useful if you could please confirm whether your MR enables you to submit the form to add a new encryption profile? If the fix does not allow the form to 'do its job' then I think an exception should be thrown. But that would mean that the exception would be returned. The empty array would not be returned. It is unclear whether the MR just suppresses the error message in the screenshot or if it makes everything work as normal?

I reverted the coding standards changes to the MR. Coding standards are being addressed at 📌 Fix phpcs and make passing phpcs mandatory in GitLab CI Needs review and are out of scope for this issue.

I recreated the issue using DDEV quickstart for Drupal 9. Drupal 9.5.11, webprofiler 9.0.2 and devel 5.1.2.

After doing a clean Drupal install using ddev, I installed encrypt then visited the encryption profile add form. The form loaded fine. Then I installed webprofiler and navigated back to the add form. The error covered the whole screen, the form did not load at all.

I applied the fix in MR 2. The form loads once again with no errors.

I was then able to complete the steps Outlined in this guide by creating the a key and encryption profile and testing the profile out to encrypt and decrypt some text.

Therefore it seems that the MR 2 is a satisfactory fix for the issue in the case of Drupal 9.5.11.

Regarding #13 I do not think this is the root cause of the error message. Because if it were the issue would appear even without the webprofiler module enabled. But this issue immediately appears when the webprofiler module is installed/ enabled.

Note that the Real AES module and other similar modules install plugins which are ready-configured encryption methods. Those then appear in the select list in the add encryption profile form. Without at least one such plugin the form could never be saved as the encryption method field is required. At least one key needs to have been created to populate the keys field, also.

I have been comparing with my Drupal 9 setup above a Drupal 10.3 setup with Encrypt version 8.x-3.x-dev. As reported at #14 (using Drupal 10.1) the issue cannot be reproduced on Drupal 10.3.

The issue arises in accordance with the version of Webprofiler module. I am using Webprofiler:9.0.2 with my Drupal 9 setup and Webprofiler:10.1.10 with my Drupal 10 setup.

9.0.2 installs a 'webprofiler' table in the database. 10.1.10 does not. 9.0.2 utilises the ConfigEntityBase::__sleep() method. 10.1.10 does not. You can comment out the ConfigEntityBase::__sleep() method and the encryption profile add form will load error free with 10.1.10.

It seems that 10.1.10 makes minimal use of serialization and does not need to utilise the ConfigEntityBase::__sleep() method and it does not need to store data in the database.