Automated Drupal 11 compatibility fixes for file_browser

This is an automated patch generated using Upgrade Status and Drupal Rector. Please see the issue summary for more details. A merge request (MR) is also openend and updated.

It is important that any automated tests available are run and that you manually test the changes.

Drupal 11 Compatibility

According to the Upgrade Status module → these changes make this module compatible with Drupal 11! 🎉
Therefore these changes update the info.yml file for Drupal 11 compatibility.

Leaving this issue open, even after committing the current patch or merging the MR, will allow the Project Update Bot → to post additional Drupal 11 compatibility fixes as they become available in Drupal Rector.

Debug information

These packages were used to generate the fixes:

1. drupal/upgrade_status: 4.3.1
2. mglaman/phpstan-drupal: 1.2.11
3. palantirnet/drupal-rector: 0.20.1

This is an automated patch generated using Upgrade Status and Drupal Rector. Please see the issue summary for more details. A merge request (MR) is also openend and updated.

It is important that any automated tests available are run and that you manually test the changes.

Drupal 11 Compatibility

According to the Upgrade Status module → these changes make this module compatible with Drupal 11! 🎉
Therefore these changes update the info.yml file for Drupal 11 compatibility.

Leaving this issue open, even after committing the current patch or merging the MR, will allow the Project Update Bot → to post additional Drupal 11 compatibility fixes as they become available in Drupal Rector.

Debug information

These packages were used to generate the fixes:

1. drupal/upgrade_status: 4.3.2
2. mglaman/phpstan-drupal: 1.2.11
3. palantirnet/drupal-rector: 0.20.2

This looks ok to me.

Needs work because tests are failing. This depends upon 📌 Automated Drupal 11 compatibility fixes for embed Needs review & 📌 Automated Drupal 11 compatibility fixes for entity_embed Needs review landing first.

I've managed to resolve most of the tests failing but I cannot resolve this one:
https://git.drupalcode.org/issue/file_browser-3451080/-/jobs/4255146

1) Drupal\Tests\file_browser\FunctionalJavascript\FileBrowserTest::testFileBrowserView
ReferenceError: Dropzone is not defined
    at Object.attach (http://localhost/web/modules/contrib/dropzonejs/js/dropzone.integration.js?v=11.1.1:16:7)
    at http://localhost/web/core/misc/drupal.js?v=11.1.1:166:24
    at Array.forEach (<anonymous>)
    at Drupal.attachBehaviors (http://localhost/web/core/misc/drupal.js?v=11.1.1:162:34)
    at http://localhost/web/core/misc/drupal.init.js?v=11.1.1:32:12
    at HTMLDocument.listener (http://localhost/web/core/misc/drupal.init.js?v=11.1.1:20:7)
TypeError: Cannot read properties of undefined (reading 'element')
    at http://localhost/web/modules/contrib/dropzonejs/modules/eb_widget/js/dropzonejs_eb_widget.common.js?v=11.1.1:15:39
    at Array.forEach (<anonymous>)
    at Object.attach (http://localhost/web/modules/contrib/dropzonejs/modules/eb_widget/js/dropzonejs_eb_widget.common.js?v=11.1.1:14:60)
    at http://localhost/web/core/misc/drupal.js?v=11.1.1:166:24
    at Array.forEach (<anonymous>)
    at Drupal.attachBehaviors (http://localhost/web/core/misc/drupal.js?v=11.1.1:162:34)
    at http://localhost/web/core/misc/drupal.init.js?v=11.1.1:32:12
    at HTMLDocument.listener (http://localhost/web/core/misc/drupal.init.js?v=11.1.1:20:7)
TypeError: $view.imagesLoaded is not a function
    at Object.attach (http://localhost/web/modules/custom/file_browser-3451080/js/file_browser.view.js?v=11.1.1:58:15)
    at http://localhost/web/core/misc/drupal.js?v=11.1.1:166:24
    at Array.forEach (<anonymous>)
    at Drupal.attachBehaviors (http://localhost/web/core/misc/drupal.js?v=11.1.1:162:34)
    at http://localhost/web/core/misc/drupal.init.js?v=11.1.1:32:12
    at HTMLDocument.listener (http://localhost/web/core/misc/drupal.init.js?v=11.1.1:20:7)
/builds/issue/file_browser-3451080/web/core/tests/Drupal/FunctionalJavascriptTests/WebDriverTestBase.php:140

Not sure how the Dropzone or imagesLoaded javascript gets loaded within the runner? Bit beyond me but if anyone else with better knowledge of it can crack that one this should be good for testing again?

Dropzone has a js library that doesn't natively get pulled in. My guess we have to add a before_script section to gitlab-ci to trigger download of the js library into the correct location.

I'll give it a go!!

Does it count if the pipeline freezes and doesn't pass or fail? Jk. Not sure if I've done this right or not:
https://git.drupalcode.org/issue/file_browser-3451080/-/pipelines/415998

From https://git.drupalcode.org/issue/file_browser-3451080/-/jobs/4258213, we should address the undefined calls to libraries_get_path

And that might be why tests are failing in https://git.drupalcode.org/issue/file_browser-3451080/-/jobs/4258217. Maybe.

Fixed those but still failing. It's not happy about this Dropzone library. Does dropzonejs need to be added as a library maybe in file_browser.libraries.yml? There's a dropzone css library entry but nothing for the js?

I think we are now at valid test failures. The library got downloaded fine at this point. I ended up copying from gitlab-ci on dropzone.

So is the issue now that we need to do the same for imagesLoaded?

Ok progressed this further but hit a wall again. Masonry is not a function. I've tried pulling in masonry from two different sources in the gitlab-ci but it's still failing.

I can't get through this failure:

There was 1 failure:
1) Drupal\Tests\file_browser\FunctionalJavascript\FileBrowserTest::testFileBrowserView
Behat\Mink\Exception\ElementNotFoundException: Button with id|name|title|alt|value "Use selected" not found.

Does anyone with better knowledge of these tests know why it wouldn't be able to find the Use selected submit input? I've manually tested the steps in the test and everything looks correct to me. I'm a bit lost now. I've managed to resolve all of the JS library loading failures but this one is beyond me!

These tests are failing due to Button with id|name|title|alt|value "Use selected" not found. I have tried various attempts to resolve this and am at my wits end with it. I suspect it may be to do with the use of the iframe or something which has changed in entity_browser itself. Feel free to take a look.

daniel.j → made their first commit to this issue’s fork.

I've made some changes and tests are now passing.

For the phpunit functional JS tests, in some places moving away from jQuery to native JS has allowed the tests to pass. Additionally, I've added a `composer.libaraies.json` file in order to add clarity to the library versions that are being used.

Please review, thanks.

This is looking good now. Can people please test so we can get this module a stable Drupal 11 release?

daniel.j → changed the visibility of the branch 3451080-d11_ready to hidden.

Any news? Desperate for a D11 release!!!

Is the module maintainer still active?

@darren.fisher, I checked out the maintainer's site (https://mortenson.coffee/) and FYI it says "I did Drupal for a long time, but am trying my hand at security engineering now." (not sure that implies he stopped doing Drupal recently?) I checked his drupal.org profile and his last credited contribution was March 31st. Not that long ago.

I changed the status to "Reviewed & tested by the community" in the hope that gets this issue the attention it deserves, plus with two people reporting this patch is fine, this feels appropriate.

I would suggest opening an issue to take over the maintenance of the project → if somebody has capacity for this.

As noted in his bio:

I am retiring a bit from Drupal.org, so unless one of my projects is actually broken I will probably not be checking on the issue queues. Thanks!

More context for this is also available here - https://www.thedroptimes.com/interview/48921/drupal-core-static-site-inn...

When can we expect this issue to be fixed into a proper release?

I'm going to apply for maintainership just to get this one out of the door.

Issue opened. Let's see what happens:
https://www.drupal.org/project/file_browser/issues/3535186 📌 Offering to co-maintain File Browser Active

It would indeed be good to get this released for D11.

In passing, I note that the core version is now v8..v11, which seems highly unlikely to be correct given all the removed interfaces over the versions. IMO we should either test on v8[latest] and v9[latest], or change that to ^10 || ^11 or similar.

Agreed. I think it would make sense to provide a new major release supporting >=10.3.

I've targeted ^10 || ^11 but the tests are now failing on an unrelated issue!

rajas samse → made their first commit to this issue’s fork.

Hello,

I have updated the README.txt file to align with modern standards and workflows for Drupal 11.
The changes are available on the "my-doc-updates" branch in the issue fork for review.
Could a contributor for MR !6 (like @d.fisher or @daniel.j) please merge this branch into the main 3451080-automated-drupal-11 branch?

Thank you!

Hey Rajas. Changes look good on first glance. I've opened a merge request:
https://git.drupalcode.org/issue/file_browser-3451080/-/merge_requests/1/

Daniel and I will review and merge if we can (we should have permission to do so). Then we aim to fix the tests which seem to have broken again and hopefully by that time I will have become a maintainer and we can roll this out to a stable release.

Hey Darren... it looks like they want you to confirm that you want to be a co-maintainer on the project over at: drupal.org/project/file_browser/issues/3535186

Standard procedure I guess.. but thought I'd give you a heads up.

Seconding #41, Darren they are waiting for you to comment back to confirm your interest in being the maintainer for this project. https://www.drupal.org/project/projectownership/issues/3535186#comment-16229930 📌 Offering to co-maintain File Browser Active

Hi everyone. Sorry. I was away on holiday with barely any signal. I'm now a maintainer and this is on my list to get this sorted tomorrow. Tests are still not passing but it seems to be an issue with the test rather than any changes to the module so I'll assess with daniel.j tomorrow and try and get this released at last!!

Slight snag. I have been made a developer on this project and not a maintainer so I can't create a 2.x branch in order to make a new major release. There are two option. We can wait another 3 week whilst I go through the process of becoming a maintainer of this project and do this properly OR we can break SEMVER and release 1.5 which will only work with Drupal 10.3 and above. Version 1.4 will remain an option for those still on Drupal 10.2 or lower. We're also working on getting this PHPUnit test to pass in order to have all valid pipelines before doing a release so whilst that's happening I'd be interested in people's thoughts on the above.

Please comment either:
Break SEMVER and just tag a 1.5 release!
or:
Wait 3 weeks and release 2.0 properly!

Thanks!

Good news everyone. I've been given full maintainer status so we can get this released. Given that the test is so flaky we are considering removing it before doing a full release. I don't like the idea of removing a test but the functionality works and the test is failing due to a known issue with selenium. I'm going to give it today and the weekend to try and get this resolved and if we're still no further progressed on Monday I will go ahead and tag a 2.0 release. Thank you all for your patience!!

My goodness. Please to finally announce that 2.0.0 is released with Drupal 11 compatibility!! Thank you to everyone for all of your efforts!!