Pager links inside a modal do not open in the modal

Re-rolled patch #5 for Drupal 9.1.x.

Kindly review a new patch.

Working on it

Could you please review this patch

Verified by applying the patch #12 , it was successfully applied but couldn't able to test the issue as getting "The service "modal_page.modals" has a dependency on a non-existent service "path.alias_manager"." on enabling the the modal_page module.

Checking

@priyanka.sahni
Could you please check after apply this patch .
https://www.drupal.org/files/issues/2020-06-09/3132535-15.patch
It's an issue with model page module and also post the patch for this .

Thanks
Pavnish

@pavinsh I verified by applying the latest modal_page modules.It was applied successfully but now i am facing issue while applying the patch #12.

@priyanka.sahni let me check

@priyanka.sahni I thing you are not using latest 9.1.x code .I have tested on 9.1.x , the patch #12 applied successfully on latest 9.1.x

For your reference please find the screenshot.

Thanks
Pavnish

@Pavinsh I am using the latest 9.1.x code.Refer to the attached screenshot.

Reroll of #12 against 9.3.x

The Needs Review Queue Bot tested this issue. It either no longer applies to Drupal core, or fails the Drupal core commit checks. Therefore, this issue status is now "Needs work".

Apart from a re-roll or rebase, this issue may need more work to address feedback in the issue or MR comments. To progress an issue, incorporate this feedback as part of the process of updating the issue. This helps other contributors to know what is outstanding.

Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.

Rebased onto an MR and added additional tests.

So using views_test_modal module from core
When I click the link (which has class use-ajax)
Modal opens
Clicking a page items renders some errors

Applying the patch

I get the same results.

Using content view with ajax turned off ( as the issue summary didn't mention turning it on)

Looking back on when we added this patch to our site it was for a paged route outside of views. Confirmed #37 that views inside modals with pagers work as long as the view has AJAX enabled (there doesn't seem to be any automated tests around this?)

Looks like testing this is also affected by #3123666: Custom classes for pager links do not work with Claro theme which also affects Olivero. Opened #3346136: Custom classes for pager links do not work with Olivero theme for that.

Added a JS test to show the issue that fails without the fix.

Test failure is due to the '#route_name' => '<current>', changes. This is required for the pager to work inside a modal as well. Since the test is just checking the query parameters are correct, we can just check that the href ends with the expected query.

So not fully understanding this issue

When ajax is enabled on the view it works fine in a modal without a fix.

Tried testing the new route added to pager_test and I get the same error with or without the fix to theme.inc

Tried testing the new route added to pager_test and I get the same error with or without the fix to theme.inc

Was that in the olivero theme? Because that needs #3346136: Custom classes for pager links do not work with Olivero theme to work. The test correctly fails without the fix.

That was the trick. I tested with a random theme I use for work, uswds,

Using the new route you added
With the change to theme.inc not there I get an error
With the change the pagination works fine.

Awesome, thanks for testing @smustgrave!

Posted review on the MR

Rebased onto 11.x and changed target. There was a conflict with 10.1.x that needed resolving first. Thanks to @larowlan for helping with the git foo.

Using only this condition:
\Drupal::request()->get(MainContentViewSubscriber::WRAPPER_FORMAT) === 'drupal_modal'
seems to fail in some use cases.
I have a modal form with ajax submit and tableselect element with pager. Applying this patch, pager links get ajaxified and work well until a validation error occurs. During submit, request wrapper format is "drupal_ajax", so after validation fails condition does not pass and links don't have use-ajax class and data attributes anymore.
Adding this:
in_array(\Drupal::request()->get(MainContentViewSubscriber::WRAPPER_FORMAT), ['drupal_ajax', 'drupal_modal'])
make pager work also after a failed validation, but i don't know if this can have unwanted side effects.

Tested with Drupal 10.2.6, it works well with pager inside modal and without views. I use pager render array like this :

[
        '#type' => 'pager',
        '#route_name' => '<current>',
]

Rebased and resolved the conflicts.

Ready for another review.

Left some comments in the MR.

Feedback addressed, I tried to find why we were using olivero and I think it was mainly to demonstrate the fix works there but I think Stark makes more sense.

Drupal\Tests\file\Functional\DownloadTest pretty sure unrelated.

Rest of the feedback appears to be addressed.

+1 RTBC, works fine when the modal has a pager.

The Needs Review Queue Bot tested this issue. It no longer applies to Drupal core. Therefore, this issue status is now "Needs work".

This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.

Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.

MR is rebased but core pipelines are having issues atm for subsystem maintainers. If someone can click rerun on the pipeline that'd be great.

Only change I wasn't sure was instantiating $link_attributes = []; vs $link_attributes = new attribute(). But seems to return the same.

Ran the test-only job here https://git.drupalcode.org/issue/drupal-3122526/-/jobs/5648445 which gave

1) Drupal\Tests\system\Unit\Pager\PreprocessPagerTest::testPagerModalAttributes
null does not match expected type "array".
/builds/issue/drupal-3122526/core/modules/system/tests/src/Unit/Pager/PreprocessPagerTest.php:218
--
1 test triggered 1 PHP warning:
1) /builds/issue/drupal-3122526/core/modules/system/tests/src/Unit/Pager/PreprocessPagerTest.php:218
Undefined array key "class"
FAILURES!
Tests: 7, Assertions: 9, Failures: 1, Warnings: 1, PHPUnit Deprecations: 7.

Appears to be 1 thread from 2 years ago but no follow up from the response. Also not sure how to do that outside the preprocess_function. Leaving thread open but don't want to hold the ticket.

Rest appears to be addressed, LGTM.

Needs a rebase.

Rebased and squashed the MR now that everything has changed.

Seems like a good rebase

Opened #3537845: Move MainContentViewSubscriber::WRAPPER_FORMAT somewhere else because it felt odd seeing the event subscriber constant referenced.

Committed/pushed to 11.x, thanks!

Agree with #65, appreciate the commit on this one. I lost count of the number of times I rebased conflicts here xD

While investigating #3567237: Mini pager and full pager behaving differently for views loaded by ajax, I think I discovered that the changes here didn't include the "Last" pager link, so I stubbed a new issue for that: #3572047: "Last" pager links inside a modal do not open in the modal.