[Meta] Roadplan for Admin Toolbar 3.6.3

Sure @ressa, no problem at all 🙂

Of course we're going to release "patch" versions of the 3.6 branch if there are any urgent issues to fix 👌
But I thought this would be straight forward enough not to require a specific ticket to request help for testing and/or plan for big changes.

I have created this issue mostly for #3286466: Tabbing order does not satisfy 508 accessibility requirements which is a very big ticket with a large amount of changes .... so I thought that could potentially require another new minor version.
Also, we "could" start considering dropping support for version below 10.3 in the next minor, since by the month of August we should be about a year away from D10 EOL....

But in any case, I wouldn't mind at all changing the target version, the title of this issue, or anything in the coming scope of work 👌

I just created this issue really to try to get a list of priorities organized for the coming months.

Feel free to make any changes, suggestions or modifications to this issue or the suggested scope of work, we would be very grateful for your help, as usual 🙏
Thanks in advance!

Small change to add in one of the next MRs to be merged:
#3527462-10: Import of strings skipped due to malformed HTML tag <br/>

A single lingering untranslated string was found in the interface, which is "milliseconds" here:

$ grep -rinoE '.{0,10}millis.{0,10}' .
./src/Form/AdminToolbarSettingsForm.php:136:ffix' => 'milliseconds',

It just needs to get wrapped in t(), and all is well:

'#field_suffix' => $this->t('milliseconds'),

See source code:
https://git.drupalcode.org/project/admin_toolbar/-/blob/3.6.1/src/Form/A...

The change suggested above at #7 was added to issue #3532249: Uncaught TypeError: toolbarElement.querySelector(...) is null and merged in with MR !163.

It can be scratched off our list 👌

Thanks a lot @ressa and sorry for the late reply 😅

I have recently focused on a bit of refactoring for the Admin Toolbar Search module and would greatly appreciate some help, if you get a chance 🙏

I have added the following ticket to the list:
#3537721: Admin Toolbar Search: Remove dependency on Admin Toolbar Tools
which has a merge request, ready to be reviewed at anytime.
I've also tried to document a bit the changes, in terms of technical or user interface impacts.

I will most likely break down more "refactoring" into multiple issues, mostly around tests, the module file and the JS, for which your help would also be definitely warmly welcome 🙂

In any case, feel free to let us know if you have any feedback, suggestions or other ideas on the added issues, it would be a great help as always.
Thanks in advance!

Super nice of you @ressa, as always! 🙏

I was able to make a bit of progress on the refactoring of the admin_toolbar_search module, as I mentioned previously and have created the first issue: #3540080: Automated tests: Merge several Functional test classes.

This is mostly some code clean-up: trying to optimize a bit the files in the code base.
The only impacted files are modules' Functional tests, but it could be good if you could just take a quick look at the MR and ticket to see if everything checks out or if I could have missed anything.

Next on the list should be module's FunctionalJavascript tests 👍
Let's keep consolidating the Tests coverage before proceeding with refactoring modules' files 😅

Once again, let me know if you spot anything or would have any suggestions, your feedback if always very helpful 🙂
Thanks in advance!

More tests refactoring coming up!

Adding another issue ready for review to the list:
#3549663: Automated tests: Add trait AdminToolbarHelperTestTrait

Hey @ressa! 🙂
Whenever you get a chance, I would greatly appreciate if you could please take a quick look at these two Tests related issues.
They should be pretty much ready to go, so it would be great if they could get merged soon. 👌

Thanks in advance for your help and feedback! 🙏

Super nice @ressa, as usual! Thanks a lot for your help!

OK, here is a big batch of tickets ready for testing 🥳

• #3550270: Remove unused Tools icon for Drupal 8
• #3550604: Automated Tests: Add Functional tests for classes ExtraLinks and SearchLinks
• #3508772: Automated tests: Improve tests for AdminToolbarToolsSettingsFormTest
• #3550652: Automated tests: Simplify admin_toolbar_search FunctionalJavascript tests

 
This should allow the tests coverage of the module to be greatly increased so we should then be able to start taking on refactoring tickets 👌

Let me know if you spot anything, have any questions or suggestions, as usual, your feedback is always very helpful! 🙏

Thanks again for all your great help with all the tickets! 🙂

Thank you so much @ressa! 🙏

Sorry I didn't reply to your other comments in other tickets, but I wanted to focus on really pushing out in priority all the Automated Tests on which I have been working for months! 😅

Some issues really took a lot of time, in particular:
#3550604: Automated Tests: Add Functional tests for classes ExtraLinks and SearchLinks 😅
Some test files are very long with lots of cases because a lot of things are being tested (more than 300 assertions).

There is still more code that could be further tested, in particular, all the Javascript code.... But for now, this should give us a much more robust, complete and stronger base for testing the module with almost 100% of the PHP code being covered, on which we should be a able to keep building. 🥳

Re #14:
Sorry I was not aware you were not familiar with automated tests 😅
Thanks a lot for contributing this documentation: we should be able to direct users who would wish to contribute to testing these issues in case they are not familiar with the required setup 👌
 

Overall the tickets at #16 have almost 0 impact on existing code files, only test classes and files should be impacted.
#3550270: Remove unused Tools icon for Drupal 8 is just some suggested clean-up task and #3550604: Automated Tests: Add Functional tests for classes ExtraLinks and SearchLinks changes slightly extra links order in the admin menu (for roles and menus)... so overall, it should be very safe to move forward with these changes.

A lot of the technical documentation in these tickets or in the code files is initially meant for me 😅
juts to remember some of the technical choices, implementations or problems identified along the way. 👍

With these tests in place, we should feel much of confident moving forward with code refactoring or certain tickets with big changes, such as #3449577: GitlabCI: Fix ESLINT validation errors.
 

In any case, feel free to let me know at any point if you have any questions or concerns on any aspects of these tickets or related merge requests, I would definitely be very happy to help. 🙂
Thanks in advance!

Adding 3 easy ones broken out from another issue so hopefully the testing and reviewing could be easier:

• #3552168: Standardize display order of extra links menu items
• #3552172: Trigger a menu link rebuild for user roles and views entity operations
• #3552177: Add 'Manage Permissions' and standardize menu label in Admin Toolbar Search suggestions

Thanks a lot @ressa!

Piling some more! 😅

Thanks so much @ressa for your great reviews and reporting back on all your tests!

We have made great progress already, with a big round of "standardization" and clean-up, with the names of the css files, icon images, inline code comments, etc...
Not to mention the improved base of automated tests! 🥳

The two remaining test issues are probably too demanding, and I hope you or someone else can review/finalize them, and maybe also the Project Browser issue?

No problem at all:
The two remaining issues are related with phpunit automated tests and should have no impact on any of the files of the module. 👌
None of the files currently in the merge requests of these issues should be outside of the tests folders.
I still need to make a few changes to these MRs by the way: add a few more checks in the FunctionalJavascript tests...
So I'll definitely take care of these issues myself.

Let's keep the Project Browser issue opened in NR a bit longer to see if we could get any feedback on the latest changes to the merge request. It is actually very easy to test: Install the latest versions of project_browser and admin_toolbar_tools ==> Crash 😅

I've seen a duplicate ticket created recently and I'm afraid this might happen more frequently and require to be released sooner...
Let's see if we could get more testing feedback on the latest suggested patch and we should be able to get this issue fixed as well 🤞

Thanks in advance @ressa for your testing feedback and reviews! 🙏

Let's keep going @ressa!!! 🤩

I've just added another big one to the list:
#3558389: Admin Toolbar Search: Refactor mobile toolbar item to use core toolbar tray

I would love to have your opinion and feedback on this one as well: More clean-up, more standardization, better focus on what the admin_toolbar_search module should really do. 👍

Once this one is done, I'll push one more big one with the clean-up and refactoring of the admin_toolbar_search JS and we should be good to WRAP UP this release! 🤞😅🥳

As always, your feedback is more than appreciated!
Thanks in advance!

Adding the last refactoring issue for the Admin Toolbar Search module 🥳🤞
#3564229: Admin Toolbar Search: Refactor admin_toolbar_search.js
which should also fix:
#3552640: Exclude random token string in link from Admin Toolbar Search

We've got part of the ESLINT completed as well, with the only file left 'admin_toolbar.js'.

Once these changes could be merged, the tests tickets should be merged as well and the new release created! 👍

Updated the target version to 3.6.3, since this release should not be introducing any BC breaking changes.

Here we are @ressa!!! 🥳

Everything is in the box now 🤩

I couldn't stop myself from adding a few more changes in this release 😅
With the ESLINT fixes and the one to add declare(strict_types=1) to PHP files...

I've just added them to this issue as well, for documentation purpose.

Just need to tag the release and create the release notes .... and we'll be done with this round 👌

New stable release coming up shortly! 🥳

That's it @ressa! 🥳

The new stable release admin_toolbar-3.6.3 was created and appears to be available on the project page as well. 👌

Thanks a lot for your great work and continued help to get all these tickets included in this release, once again! 🤩

I "think" there are 21 issues listed in the "Done" section, so we probably fixed between 25 to 30 issues, counting the ones for support requests, for example. 🏆💪

Overall, a lot of refactoring work, code cleanup and review have been done, which is a big step towards module standardization. 👍
Module's automated tests coverage was greatly increased and the code base was brought into compliance with all the validation jobs available on Gitlab CI: passing all 🟢
Things are starting to feel like they're held a bit tighter in the code base.

However, we might very well have broken some things here or there, which we could not necessarily have tested with our setups 😅
and thus, we probably need to be prepared for incoming bug reports/issues, as usual 🙈😅
No problem at all for creating quick follow-up patch releases if needed, as we did before.

Otherwise, I should probably start drafting a 3.7 Roadmap plan, which would mostly include dropping support for D<10.3 and should allow us to start modernizing module's code base with the latest standards and APIs. 🤓
Of course, we should also probably re-evaluate the max bundle number feature with issues such as #3554351: Spell it out which sub-menus are affected by Maximum number to display setting
... and many other tickets in the queue: Support for core Navigation, Gin Theme, Accessibility, etc...
See: #3565206: [Meta] Roadplan for Admin Toolbar 3.7 and 4.x

Let me know if you spot anything in the release notes or maybe something I could have missed, I would be glad to make adjustments to the documentation. 😊
Thank you very much @ressa for all your contributions, constructive help and sincere involvement in the Drupal and Open Source community!

Re #31:

Maybe you already know it, but if not, I heard about https://drupal-mrn.dev/ the other day, so just in case, I'll mention it.

Thanks a lot @ressa! I didn't know this site 🤩
Looks like people have got super lazy 😅

From the same author, I've been using:
https://github.com/mglaman/drupalorg-cli
(already quite lazy 😅)

Which was suggested by Adrian to Jakob in one of the maintainers tickets of this module 😅

I've given a quick test to the tool on the site and it seems to work really well, as well.
The generated markup even seems to include more things than the one from the cli command 👍

I've copied the compare versions link, which is very practical and not included in the HTML generated with the command.

Thanks again very much! 🙏

@ressa!!! 🤩
Thank you so much for everything and all your great help without which honestly I don't think we would have been able to go this far! 🙏

Sorry for the late reply, but I've already started looking at the next issues, in particular, I've done an initial big round of core API updates to #3565209: [Meta] Drop support for Drupal 10.2 and below. 👍
I've pushed a bit everything in the same merge request, but it will most likely need to be broken down into 4 or 5 different issues. 👌
... This is going to be a big change, since we would be dropping support for D9... But come on .... We've got to be able to move forward and modernize module's code base with the most recent versions of Drupal and PHP.

I've seen you have also started adding new functional issues, for features improvements, which is great! Thanks a lot! 😊

I've also started looking into #3532958: Make obvious when toolbar search returning no results and should be able to create a merge request within the next few weeks.
We've got lots of interesting issues and topics, whether looking ahead at the compatibility with Gin / Navigation, or the Compact display you have suggested 👍
I'll see if in the midst of all that we could squeeze in a bit of documentation with the #3520700: Update the project page, to take a break from more technical tasks and coding 😊

So far.... Overall, after a week and probably more than 10K installs/updates.... We've got 0 bug raised! 🥳
For a big refactoring release, with 21 commits and 6 months work ... that's pretty amazing!! 😅😆

Let's hope it stays this way 😅🤞

oh ... and of course, I made all the changes you recommended above at #35 to the release notes, last Friday or Saturday 👌
But, please let me know if I missed anything, I would be glad to make more changes if needed.
Otherwise.... Moving ON to 3.7!!! 🥳

Thanks again for everything @ressa!! 🙏🤩