Provide an excerpt field to use in view modes.

The testfail is not related, but we should create a new integration test to fix this.

in #4 you mentioned that we still needed to disable the caching for that field, is that still the case?

Works as expected with the built-in Database backend (thus not using SOLR). Missing a field label though. See screenshot.

Awesome idea, thanks!
Attached are a few small code style corrections for now. Otherwise, yes, we still need a test for this, plus apparently the caching fix (which should also be covered by the test, of course).
But great work so far!

• Added cache tags to the markup to ensure that the highlighted term changes on a new search request.
• Updated testHighlighting()
• The Schema update from this comment is required to make the test pass: https://www.drupal.org/project/search_api/issues/2983640#comment-12673864

Thanks!
In the future, though, please provide an interdiff when posting a new revision of an existing patch!

Regarding the changes: the url.query_args cache context is a good attempt to keep cacheability, but I don’t think this would be enough. Search keywords aren’t guaranteed to come via query parameters – e.g., in the Search API Pages module, they are passed as part of the path.
So, until we have something like a search_api.keys context, I fear we have to stick with a max-age of 0.

The test change seems not really related? That code tests the normal “Search: Excerpt” field, unless I’m mistaken. We still need code that tests this current patch.

Hi,

I tested #14, with search API and Search API page.
On my "search api page", I switched to display result through view mode.

I do have the extrafield in the view mode, but the value is NULL: nothing is rendered for the extrafield. When debugging, it doesn't seem to go through the method render() in SearchApiRow class.

Is it right ?

Hi

I just applied this patch to search_api module (version 8.x-1.12). But dynamic field is not created because of the below condition. I did following change in the patch then it shows the dynamic field.

from:

if ($entity_type instanceof ContentEntityType) {

to

if ($entity_type instanceof \Drupal\Core\Entity\ContentEntityType) {

Am I right here? Thanks

Sorry I missed to add name space while applying the patch manually. I applied the patch manually because I got error while applying via GIT. Thanks

I approached this slightly different in my own module to handle this for now in case it is useful for anyone:

<?php

namespace Drupal\my_module\Plugin\views\row;

use Drupal\search_api\Plugin\views\row\SearchApiRow;

/**
 * Provides a row plugin for displaying a result as a rendered item.
 *
 * @ViewsRow(
 *   id = "search_api_with_excerpt",
 *   title = @Translation("Rendered entity with excerpt"),
 *   help = @Translation("Displays entity of the matching search API item
 *   passing an excerpt"),
 * )
 *
 * @see search_api_views_plugins_row_alter()
 */
class SearchApiRowWithExcerpt extends SearchApiRow {

  /**
   * {@inheritdoc}
   */
  public function render($row) {
    $build = parent::render($row);

    // Pass the #search_api_excerpt to the node template. It becomes available
    // in twig in `{{ elements['#search_api_excerpt'] }}`.
    $build['#search_api_excerpt'] = $row->search_api_excerpt;

    // Set cache to match the parameter used for the highlight.
    $build['#cache'] = $build['#cache'] ?? [];
    $build['#cache'] = array_merge_recursive($build['#cache'], [
      'contexts' => [
        'url.query_args:keywords',
      ],
    ]);
    return $build;
  }
}

Noting the following:

1. Cache context assumes you are using GET for search
2. Cache context keywords should match the query string arg for your own search
3. To add, select View > Format > Show > Rendered entity with excerpt
4. Becomes available in your `node--view-mode-here.html.twig` as `{{ elements['#search_api_excerpt'] }}`

I couldn't figure out a reroll, so reapplied all individual hunks. Next up: removing test change and writing a new testcase.

Back to needs work.

I made an oopsie.

Forgot another use. Also made a change for readability already.

Got my local test-env working again, thanks to @wannesderoy, should be green again now. Working on a test.

I have no clue how to write a test for this. I actually spent most of the last 2 days working on this but I don't know how to do this.

@drunken monkey please halp?

Thanks a lot for moving this along, Joris!

I have no clue how to write a test for this. I actually spent most of the last 2 days working on this but I don't know how to do this.

@drunken monkey please halp?

Oh, wow. Thanks again, then, for that!
Unfortunately, I don’t have the time right now to work on this, either (maybe later this week), but I think it would need a Functional test where you include a view mode config that uses the new search_api_excerpt field and some hook, processor or the test backend to add an excerpt to the results for whose presence you can then check on the search results page.
If you tried that already: which part of it caused problems?

Also, something completely different: Can’t we also support this new field in the RenderedItem processor if called during search results rendering? See attached patch revision.

OK, took a bit but seems to work fine.
The (Views) test is still a bit bare, maybe it should be expanded to also test proper caching? (E.g., visit the page again and verify that the rendered node was retrieved from cache (not sure, how, though?), then use different query args and verify it didn’t touch the cache. (Probably need to adapt search_api_test_excerpt_field_search_api_results_alter() for that.))

Implemented my suggestions from #32.

Ok, I think this looks done now. +1 Thanks for helping out @drunken monkey :)

Alright, then, thanks for reviewing again!
Committed.
Thanks a lot again, everyone!