Problem/Motivation

menu_local_tabs() is not used in core it seems and LocalTasksBlock calls it directly.

Proposed resolution

Just deprecate it in favor of using the block or using the theme function directly.

Specifically, trigger errors for menu_local_tabs(), menu_secondary_local_tasks() and menu_primary_local_tasks(), and write a legacy test file for those functions along with menu_cache_clear_all() which is already triggering an error.

Remaining tasks

  • Create CR
  • Add the deprecation notice
  • Add the legacy test
CommentFileSizeAuthor
#22 interdiff.3021718.17-22.txt944 bytesmikelutz
#22 3021718-22.drupal.Deprecate-menulocaltabs.patch4.83 KBmikelutz
#18 3021718-18.patch4.33 KBandypost
#18 interdiff.txt5.74 KBandypost
#15 3021718-15.patch4.18 KBandypost
#15 interdiff.txt4.37 KBandypost
#14 3021718-14.patch4.17 KBglu2006
#14 interdiff.txt4.05 KBglu2006
#4 3021718-4.patch1.75 KBandypost
#4 interdiff.txt494 bytesandypost
#3 3021718-3.patch1.79 KBandypost

Comments

voleger created an issue. See original summary.

andypost’s picture

andypost
he/him
Primary language Russian
commented

Only one contrib using it http://grep.xnddx.ru/search?text=menu_local_tabs

andypost’s picture

andypost
he/him
Primary language Russian
commented
Status: Active » Needs review
StatusFileSize
new 3021718-3.patch1.79 KB

Filed CR https://www.drupal.org/node/3021778

Any idea how to extend deprecation test to make sure non empty array returned?

andypost’s picture

andypost
he/him
Primary language Russian
commented
StatusFileSize
new interdiff.txt494 bytes
new 3021718-4.patch1.75 KB

a bit of clean-up

andypost’s picture

andypost
he/him
Primary language Russian
commented
Issue tags: +Kill includes
voleger’s picture

voleger
he/his
Primary language Ukrainian
Location Ukraine, Rivne
commented

Any idea how to extend deprecation test to make sure non empty array returned?

The simplest way is to convert Kernel test to Functional and using drupalGet change the route context. For example, we can enable the user module and go to the user.page route that has local tasks, so in that route context will return non-empty array.
Maybe its possible to do in Kernel test, but I have no idea for now.

anpolimus’s picture

anpolimus
Primary language Ukrainian
Location Kyiv
commented

@andypost. I think that this branch needs reroll.
Current version of 8.7.x branch already has another comments sections.

For example:
https://cgit.drupalcode.org/drupal/tree/core/includes/menu.inc?h=8.7.x#n151

Could you, please, approve that I'm right?

glu2006’s picture

glu2006 commented

Patch applies cleanly, no idea which comment changed.

voleger’s picture

voleger
he/his
Primary language Ukrainian
Location Ukraine, Rivne
commented

I tried to convert and update a test to make the function return a non-empty value. But without success. Function relies on routeMatch service and that service always returns <none> route name during the test. So maybe someone knows how to put the desired request into requestStack service to be able to define the current route that has related local tasks. That will help return a non-empty value.

andypost’s picture

andypost
he/him
Primary language Russian
commented

I think we should not test all possible permutations cos goal of the test to be sure that deprecation fires

voleger’s picture

voleger
he/his
Primary language Ukrainian
Location Ukraine, Rivne
commented
Status: Needs review » Reviewed & tested by the community

In that case, +1 for rtbc.
The legacy test has the call of the deprecated function and the other tests are green.

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
commented
Status: Reviewed & tested by the community » Needs work

I think having another CR and not using https://www.drupal.org/node/2874695 is tricky - too many CRs are confusing. Since menu_primary_local_tasks() and menu_secondary_local_tasks() and menu_local_tabs() are all so linked. Let's:

  1. Add this issue to https://www.drupal.org/node/2874695
  2. Add @trigger_error() to menu_primary_local_tasks() and menu_secondary_local_tasks()
  3. Add assertions for the new @trigger_error()'s to the test.
  4. Delete https://www.drupal.org/node/3021778
andypost’s picture

andypost
he/him
Primary language Russian
commented

I did update old CR https://www.drupal.org/node/2874695 and have no rights to delete https://www.drupal.org/node/3021778

glu2006’s picture

glu2006 commented
Status: Needs work » Needs review
StatusFileSize
new interdiff.txt4.05 KB
new 3021718-14.patch4.17 KB

address #12

andypost’s picture

andypost
he/him
Primary language Russian
commented
Issue tags: +@deprecated
StatusFileSize
new interdiff.txt4.37 KB
new 3021718-15.patch4.18 KB

Fix messages according #3024461: Adopt consistent deprecation format for core and contrib deprecation messages

Version: 8.7.x-dev » 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

berdir’s picture

berdir
Primary language German
Location Switzerland
commented
Status: Needs review » Needs work

That needs an update now :)

andypost’s picture

andypost
he/him
Primary language Russian
commented
Status: Needs work » Needs review
StatusFileSize
new interdiff.txt5.74 KB
new 3021718-18.patch4.33 KB

Fixed again)
Updated CR

berdir’s picture

berdir
Primary language German
Location Switzerland
commented

See my comment in #3021823: Properly deprecate functions in menu.inc, should we include that last function/merge these two issues together?

Status: Needs review » Needs work

The last submitted patch, 18: 3021718-18.patch, failed testing. View results

andypost’s picture

andypost
he/him
Primary language Russian
commented
Status: Needs work » Needs review

bot flux

mikelutz’s picture

mikelutz
He/Him
Primary language English
Location Michigan, USA
commented
Title: Deprecate menu_local_tabs() » Properly deprecate menu_local_tabs(), menu_secondary_local_tasks(), menu_primary_local_tasks()
Issue summary: View changes
StatusFileSize
new 3021718-22.drupal.Deprecate-menulocaltabs.patch4.83 KB
new interdiff.3021718.17-22.txt944 bytes

The last function from the other issue already got it's @trigger_error in #2248983: Define the revision metadata base fields in the entity annotation in order for the storage to create them only in the revision table, It's just missing a legacy test. I think it's fine to include a test for that in this issue.

andypost’s picture

andypost
he/him
Primary language Russian
commented
Status: Needs review » Reviewed & tested by the community

Ah the only one, then makes sense

catch’s picture

catch
he/him
Primary language English
commented
Status: Reviewed & tested by the community » Fixed

Committed e4b2539 and pushed to 8.8.x. Thanks!

  • catch committed e4b2539 on 8.8.x 
    Issue #3021718 by andypost, glu2006, mikelutz, voleger, alexpott:...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.