Comments

drunken monkey created an issue. See original summary.

drunken monkey’s picture

Issue tags: +Release blocker

We now actually use the tracker description – but only if the tracker has a config form. So that needs to change, plus the datasource description (which is, apparently, still unused).

drunken monkey’s picture

Status: Active » Needs review
Issue tags: +Needs tests
StatusFileSize
new8.97 KB

Here's one suggestion: Just use the descriptions as descriptions for the radio buttons. Very straight-forward, and solves all problems, as far as I can see.
Did the same for server backends, while I was at it – makes things consistent, and also displays the description if a server has no config form. (Might have worked before, too, though – not sure.)
I also removed the ContentEntity::getDescription() override, since that didn't really make any sense for how the description is now used (and, in general, for what a description is supposed to be – it was more a config summary, really, like Views' adminSummary()).
Finally, I changed the magic config key the server is passed into the backend plugin constructor to #server – we already did that for index plugins a while back, but seem to have forgotten to do the same for backends.

Probably should get some tests to make sure the descriptions are correctly displayed, but I gotta go now, so no time at the moment.

drunken monkey’s picture

Issue tags: -Needs tests
StatusFileSize
new1.64 KB
new10.62 KB

Simple enough. ("Tests only" patch is the interdiff.)

drunken monkey’s picture

Component: Framework » User interface
borisson_’s picture

Status: Needs review » Reviewed & tested by the community

Testbot is really slow today, patch looks good and has coverage. Great work Thomas

The last submitted patch, 4: 2681273-4--use_plugin_descriptions--tests_only.patch, failed testing.

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 4: 2681273-4--use_plugin_descriptions.patch, failed testing.

drunken monkey’s picture

Status: Needs work » Reviewed & tested by the community

Thanks for reviewing, good to hear!
Let's see whether we can get the test bot to approve, too …

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 4: 2681273-4--use_plugin_descriptions.patch, failed testing.

drunken monkey’s picture

Status: Needs work » Reviewed & tested by the community
StatusFileSize
new977 bytes
new10.89 KB

Huh, weird … Let's try with this one, shortly, to maybe get more helpful diagnostics. (Not a real suggestion.)

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 11: 2681273-11--use_plugin_descriptions.patch, failed testing.

drunken monkey’s picture

Status: Needs work » Reviewed & tested by the community
StatusFileSize
new902 bytes
new10.9 KB

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 13: 2681273-13--use_plugin_descriptions.patch, failed testing.

drunken monkey’s picture

Status: Needs work » Reviewed & tested by the community
StatusFileSize
new743 bytes
new10.91 KB

Failed asserting that 'File Provides File entities for indexing and searching. Search task Provides Search task entities fo' contains "Provides File entities for indexing and searching.".

What.

Does anyone have any explanation for this?
Trying with an additional cast, maybe that's it?

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 15: 2681273-15--use_plugin_descriptions.patch, failed testing.

drunken monkey’s picture

As said in a different issue, I just get an "A non-numeric value encountered" error when running functional tests locally at the moment. Can anyone reproduce this fail (and possibly debug)? Otherwise, I guess an issue in the Drupal CI queue is in order.

borisson_’s picture

I ran the tests locally and I can reproduce the issue, the command i used is: $ vendor/bin/phpunit -c core/ modules/globalignore/search_api --filter testFramework --printer="\Drupal\Tests\Listener

The error is: Failed asserting that 'File Provides File entities for indexing and searching. Search task Provides Search task entities fo' contains "Provides <em class="placeholder">File</em> entities for indexing and searching."., I think the placeholder is what's wrong here.

I'll try to figure out how to actually fix that after I've had food.

drunken monkey’s picture

Status: Needs work » Needs review
StatusFileSize
new730 bytes
new10.72 KB

Ah, that does make sense. Thanks a lot for testing, this really helped me out!
The attached patch should fix this, I'd say (interdiff based on #4).

Also opened #2849425: Test bot apparently strips tags from fail/error message for the test bot – this is really not a very helpful behavior.

Status: Needs review » Needs work

The last submitted patch, 19: 2681273-19--use_plugin_descriptions.patch, failed testing.

drunken monkey’s picture

drunken monkey’s picture

Status: Needs work » Needs review
borisson_’s picture

Status: Needs review » Reviewed & tested by the community

Such a small change, well done @drunken monkey! Thanks for picking this up after I'd said I'd do it. Sorry.

  • drunken monkey committed 141f4f4 on 8.x-1.x
    Issue #2681273 by drunken monkey, borisson_: Added plugin descriptions...
drunken monkey’s picture

Status: Reviewed & tested by the community » Fixed

No problem at all! You still deserve credit for reproducing the test fail and thus helping me find the problem. As you see, it just required a small change, so I'd thought I'd just make that change.
Anyways, good to see this finally passing. Committed.
Thanks again for your help!

Status: Fixed » Closed (fixed)

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