[hibernate-search] Cannot inject CDI bean in @SearchExtension classes

[cthiebault]

Describe the bug

I would like to prefix the name of my indices with the name of the environment in which they are created.
The environment is defined in the application.properties file.

I tried to implement org.hibernate.search.backend.elasticsearch.index.layout.IndexLayoutStrategy
but I cannot inject the prefix: the injected prefix is always null.

// adapted version of org.hibernate.search.backend.elasticsearch.index.layout.impl.SimpleIndexLayoutStrategy
@SearchExtension
public class PrefixIndexLayoutStrategy implements IndexLayoutStrategy {

    @ConfigProperty(name = "index-prefix")
    String prefix;

    @Override
    public String createInitialElasticsearchIndexName(String hibernateSearchIndexName) {
        return prefix + hibernateSearchIndexName + "-000001";
    }

    @Override
    public String createWriteAlias(String hibernateSearchIndexName) {
        return prefix + hibernateSearchIndexName + "-write";
    }

    @Override
    public String createReadAlias(String hibernateSearchIndexName) {
        return prefix + hibernateSearchIndexName + "-read";
    }

    @Override
    public String extractUniqueKeyFromHibernateSearchIndexName(String hibernateSearchIndexName) {
        return prefix + hibernateSearchIndexName;
    }

    @Override
    public String extractUniqueKeyFromElasticsearchIndexName(String elasticsearchIndexName) {
        Matcher matcher = SimpleIndexLayoutStrategy.UNIQUE_KEY_EXTRACTION_PATTERN.matcher(elasticsearchIndexName);
        if (!matcher.matches()) {
            throw new SearchException(
                    String.format(
                            "Invalid Elasticsearch index layout:"
                                    + " primary (non-alias) name for existing Elasticsearch index '%1$s'"
                                    + " does not match the expected pattern '%2$s'.",
                            elasticsearchIndexName, SimpleIndexLayoutStrategy.UNIQUE_KEY_EXTRACTION_PATTERN));
        }
        return matcher.group(1);
    }

}

Expected behavior

I would expect to be able to inject CDI beans to @SearchExtension beans

Actual behavior

No response

How to Reproduce?

No response

Output of uname -a or ver

No response

Output of java -version

21.0.2

Quarkus version or git rev

3.11.3

Build tool (ie. output of mvnw --version or gradlew --version)

No response

Additional information

No response

[quarkus-bot]

/cc @Ladicek (arc), @gsmet (hibernate-search), @manovotn (arc), @marko-bekhta (hibernate-search), @mkouba (arc), @yrodiere (hibernate-search)

[marko-bekhta]

hey @cthiebault
Thanks for reporting the issue. I tried to reproduce this, but in my case I got the property injected. Any chance you could create a simple reproducer?

[cthiebault]

Thanks @marko-bekhta!
I will try to setup a repo to reproduce this.
FYI I'm using Kotlin... I don't know if it could be the reason...

[cthiebault]

My bad! It works!

When I wrote a simple app to reproduce this issue, it worked.
Checking my main app, I saw a mismatch config between elasticsearch and opensearch...

Thanks @marko-bekhta for your quick anwers :-)

[marko-bekhta]

No worries 😃, glad you figured it out.

[cthiebault]

I don't know if I should open another issue, but when I run my application (prod profile in k8s) with this custom IndexLayoutStrategy and an injected config property (as optional), I get

A runtime config property value differs from the value that was injected during the static intialization phase:
- the runtime value of 'index-prefix' is [dev-] but the value [null] was injected into myapp.PrefixIndexLayoutStrategy()

If that's intentional then annotate the injected field/parameter with @io.quarkus.runtime.annotations.StaticInitSafe to eliminate the false positive.

I read #37444 and tried to inject

@ConfigProperty(name = "index-prefix")
Instance<Optional<String>> prefix;

but it didn't work better :-(

[yrodiere]

I believe the index layout strategy is used by Hibernate Search at static init, so you can't use runtime properties in there. I'd suggest opening a feature request to make the index layout strategy a runtime component (which makes sense)

FWIW it'll probably require changes to Hibernate Search itself, since it currently creates index names very (too?) early, for no good reason that I can see (the names aren't used until runtime): https://github.com/hibernate/hibernate-search/blob/0b9e3f0d87250daa800f10223bcc81cdb0da773a/backend/elasticsearch/src/main/java/org/hibernate/search/backend/elasticsearch/impl/ElasticsearchBackendImpl.java#L206