openeuropa/oe_search

Search features for the OpenEuropa project.

2.13.0 2025-03-26 11:28 UTC

Requires

• php: >=8.1
• drupal/core: ^10 || ^11
• drupal/search_api: ^1.37
• guzzlehttp/guzzle: ^7
• laminas/laminas-diactoros: ^2.11.1
• openeuropa/europa-search-client: ^1.0@alpha

Requires (Dev)

• composer/installers: ^1.5
• drupal/core-composer-scaffold: ^10 || ^11
• drupal/core-dev: ^10 || ^11
• drupal/http_request_mock: ^1.2
• drush/drush: ^12.4 || ^13
• openeuropa/code-review-drupal: ^1.0.0-alpha
• openeuropa/oe_multilingual: ^1.20
• openeuropa/task-runner-drupal-project-symlink: ^1.0
• phpspec/prophecy-phpunit: ^2

EUPL-1.2

README

The OpenEuropa Search module integrates Europa Search Client with Search API.

Europa Search is the corporate search engine for the European Commission.

Features provided

• Search
• Ingestion (Content and Files)
• Multilingual support
• Facet support

Usage

Before using Corporate Search, API Key, Consumer Key and Consumer Secret are needed. All this information can be provided together with the correct endpoints by Corporate Search Team during the onboarding process.

Please note that for any Corporate Search application to work with the SearchAPI, the following fields must exist in the related index. These fields should be added when the application is created in Corporate Search. The Search API will not work without them.

    SEARCH_API_ID
    SEARCH_API_DATASOURCE
    SEARCH_API_LANGUAGE
    SEARCH_API_SITE_HASH
    SEARCH_API_INDEX_ID

It is recommended to explore the functionality by first installing and configuring the Demo module. Please refer to the demo documentation to understand how to configure the different endpoints and credentials. When configured correctly the number of documents in the Search API index should show the total number of documents in the Europa Search database.

Limitations

• Only content entities can be ingested.
• Ingested entities should expose a canonical URL. Alternatively, third-party code may alter the document being ingested and provide an arbitrary URL. See the API section below.

Requirements

• PHP 8.1 or newer.
• Drupal >= 10.
• Search API Drupal module 1.19 or newer.
• Europa Search Client library.

For a full list of dependencies, please check the composer.json file.

Development setup

You can build the development site by running the following steps:

• Install the Composer dependencies:

composer install

A post command hook (drupal:site-setup) is triggered automatically after composer install. It will make sure that the necessary symlinks are properly setup in the development site. It will also perform token substitution in development configuration files such as behat.yml.dist.

• Install test site by running:

./vendor/bin/run drupal:site-install

Your test site will be available at http://localhost:8080/build.

Please note: project files and directories are symlinked within the test site by using the OpenEuropa Task Runner's Drupal project symlink command.

If you add a new file or directory in the root of the project, you need to re-run drupal:site-setup in order to make sure they are be correctly symlinked.

If you don't want to re-run a full site setup for that, you can simply run:

$ ./vendor/bin/run drupal:symlink-project

Using Docker Compose

Alternatively, you can build a development site using Docker and Docker Compose with the provided configuration.

Docker provides the necessary services and tools such as a web server and a database server to get the site running, regardless of your local host configuration.

Requirements:

• Docker
• Docker Compose

Configuration

By default, Docker Compose reads two files, a docker-compose.yml and an optional docker-compose.override.yml file. By convention, the docker-compose.yml contains your base configuration and it's provided by default. The override file, as its name implies, can contain configuration overrides for existing services or entirely new services. If a service is defined in both files, Docker Compose merges the configurations.

Find more information on Docker Compose extension mechanism on the official Docker Compose documentation.

Usage

To start, run:

docker-compose up

It's advised to not daemonize docker-compose so you can turn it off (CTRL+C) quickly when you're done working. However, if you'd like to daemonize it, you have to add the flag -d:

docker-compose up -d

Then:

docker-compose exec web composer install
docker-compose exec web ./vendor/bin/run drupal:site-install

Using default configuration, the development site files should be available in the build directory and the development site should be available at: http://127.0.0.1:8080/build.

Running the tests

To run the grumphp checks:

docker-compose exec web ./vendor/bin/grumphp run

To run the phpunit tests:

docker-compose exec web ./vendor/bin/phpunit

Step debugging

To enable step debugging from the command line, pass the XDEBUG_SESSION environment variable with any value to the container:

docker-compose exec -e XDEBUG_SESSION=1 web <your command>

Please note that, starting from XDebug 3, a connection error message will be outputted in the console if the variable is set but your client is not listening for debugging connections. The error message will cause false negatives for PHPUnit tests.

To initiate step debugging from the browser, set the correct cookie using a browser extension or a bookmarklet like the ones generated at https://www.jetbrains.com/phpstorm/marklets/.

Contributing

Please read the full documentation for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the available versions, see the tags on this repository.

API

Alter a document being ingested (indexed)

Third party modules are able to intercept and alter the indexed document subscribing to Drupal\oe_search\Event\DocumentCreationEvent event:

mymodule.service.yml:

services:
  mymodule.alter_indexed_doc:
    class: Drupal\mymodule\EventSubscriber\AlterIndexedDocSubscriber
    tags:
      - { name: 'event_subscriber' }

src/EventSubscriber/AlterIndexedDocSubscriber.php:

<?php

namespace Drupal\mymodule\EventSubscriber;

use Drupal\oe_search\Event\DocumentCreationEvent;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

class AlterIndexedDocSubscriber implements EventSubscriberInterface {

  public static function getSubscribedEvents(): array {
    return [DocumentCreationEvent::class => 'setReleased'];
  }

  public function setReleased(DocumentCreationEvent $event): void {
    $entity = $event->getEntity();
    if ($entity->getEntityTypeId() === 'foo') {
      $event->getDocument()->setUrl("http://example.com/{$entity->uuid()}");
    }
  }

}