UHF-11462: Performance improvements to Linked Events query parameter handling

[wktohesi]

UHF-11462

Requests from Linked Events React search components to Linked Events API are currently prone to timeouts, especially when a text search query parameter is included. It was suggested in the ticket that using a keyword instead would make the request more performant. This PR attempts to do just that.

Background investigation and performance testing

• A db query on "Työ ja yrittäminen" revealed all linked events paragraphs that have a text-parameter use the word tyollisuus or työllisyys (identical in terms of results). They will then all benefit from converting the text based search into a keyword based.
• Tested calling the api with the current request structure and the suggested alteration
  • Current: https://api.hel.fi/linkedevents/v1/event/?event_type=General&format=json&include=keywords%2Clocation&page=1&page_size=10&sort=end_time&start=now&super_event_type=umbrella%2Cnone&language=fi&all_ongoing_AND=tyollisyys
    • Response time (uncached) ~ 8.5 seconds
  • Altered: https://api.hel.fi/linkedevents/v1/event/?event_type=General&format=json&include=keywords%2Clocation&page=1&page_size=10&sort=end_time&start=now&super_event_type=umbrella%2Cnone&language=fi&all_ongoing=true&keyword=yso:p6357
    • Response time (uncached) ~ 2.5 seconds
• This alteration currently only benefits the embeds in "Työ ja ympäristö", but can be extended. Also this alteration is not easily done as there's no keyword filtering available in https://tapahtumat.hel.fi/ .
• For example "Kasvatus ja koulutus" has lot's of embeds where the text based search could be replaced with a location filter (would result in the same performance improvement). It's possible to do location filtering in https://tapahtumat.hel.fi/ , so this should be easily achieved by content editors.

What was done

• Adds a text parameter handler where certain text searches can be converted into keyword parameters instead of using the less performant all_ongoing_AND-parameter, which is still the default fot texts other than tyollisuus or työllisyys. This was removed after discussing with Aleksi. Better to use this enhancement manually for now (by adding the keyword parameter manually) which makes it a conscious decision between a slightly different result set and performance.
• Adds parameter handling for a manual keyword query parameter to allow filtering with known keywords (even though such filtering isn't available in https://tapahtumat.hel.fi/). Also makes sure keywords can be set from different parameters without them overriding each other.
• Updates unit tests to cover some parameter handling use cases.

How to install

See install steps in City-of-Helsinki/drupal-hdbt#1196

How to test

• Check that keyword parameters set by different parameter handlers work together
  • Go to https://helfi-elo.docker.so/fi/yritykset-ja-tyo/tyollisyyspalveluiden-tapahtumat and edit the page.
  • Update the Api URL-field with https://tapahtumat.hel.fi/fi/haku?start=2025-01-31&categories=movie&keyword=yso:p6357 and Save
  • Open inspector network tab and search for api.hel.fi/linkedevents/v1 (reload if needed to get it there)
  • Make sure the api call includes multiple values in the keyword-parameter (one manual and one set by the categories-handling)
• Check that code follows our standards

Continuous documentation

• This change doesn't require updates to the documentation

Other PRs

• UHF-11462: Fix to remove duplicate query parameters from linkedevents api request url drupal-hdbt#1196

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud