Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Allow just registerPredicate for the polling to be overridden/configured for PerResourcePollingDependentResources

Aberta
  • Algo errado?
#2,783 6 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
48/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
java
Domínio
backend-api-design

Direção de pesquisa

Comece lendo PerResourcePollingDependentResource.createEventSource e PerResourcePollingConfigurationBuilder.withRegisterPredicate para entender a configuração de polling existente. Adicione o comportamento substituível de pollingRegisterPredicate descrito na issue, preserve o comportamento padrão atual de polling e documente como os predicados de registro interagem com os filtros do informer e o polling de recursos.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

Is your feature request related to a problem? Please describe.

When using the PerResourcePollingDependentResource and you do not want polling (yet) for certain resources, it is hard to discover and cumbersome that you need to override the createEventSource method (which happens to be the only implemented method of that class) just to add the single line withRegisterPredicate(mypredicate::test) to the PerResourcePollingConfigurationBuilder-builder (which also happens to be the only configuration property that is not already out-of-the-box overridable when using PerResourcePollingDependentResource).
This has the additional downside that if the code for PerResourcePollingDependentResource.createEventSource is improved, we'd have to update our overridden method accordingly because we want the same behaviour, just only with the registerPredicate.

Describe the solution you'd like

A pollingRegisterPredicate method on PerResourcePollingDependentResource that could be overridden and by default returns null. Eg

@Override
protected Predicate<MyResource> pollingRegisterPredicate() {
   return resource -> "someType".equals(resource.getSpec().type());
}

PerResourcePollingDependentResource could then use this method to configure the registerPredicate when setting op the polling event source.

Additionally, documenting the fact that by default polling is started for every resource (even if the depending reconciler has informer filters) and how this could be adjusted would greatly help new consumers.

Alternatively, an annotation @PollingRegisterPredicate could be added to your class that would then get picked up by PerResourcePollingDependentResource.

Describe alternatives you've considered

For our case (see below), it would also work if the polling picks up on the genericFilter/onAddFilter in the @ControllerConfiguration/@Informer annotations on the depending reconciler, so that the polling does not start if no event is processed by the reconciler.

We recognize that his may be too specific to our use case which may not apply to other people and is also more complex than exposing the existing registerPredicate a bit more which would also be more generic.

Additional context

Our use case is that we have a reconciler with a PerResourcePollingDependentResource which polls an external system. Our reconciler should only reconcile specific resources within a kind (eg based on a static type field). We achieve this by adding a genericFilter to the @ControllerConfiguration/@Informer annotation:

@ControllerConfiguration(informer = @Informer(genericFilter = PredicateClass.class) ...)

We noticed that, even for resources not being handled by the reconciler, polling was being started and the external system was being queried. This puts load on the operator and the external system for resource we know will never need something to happen in the external system.

This behaviour is not (clearly) documented and required some digging around to discover that PerResourcePollingConfigurationBuilder has the method withRegisterPredicate which to control this behaviour, but this method is not used by the PerResourcePollingDependentResource.
To use this register predicate, it's therefor required to override the createEventSource method of PerResourcePollingDependentResource, just to add the register predicate:

@Override
protected ExternalResourceCachingEventSource<MyInfo, MyResource> createEventSource(EventSourceContext<MyResource> context) {
		return new PerResourcePollingEventSource<>(
				resourceType(),
				context,
				new PerResourcePollingConfigurationBuilder<>(this, getPollingPeriod())
						.withCacheKeyMapper(this)
						.withName(name())
						.withRegisterPredicate(resource -> "someType".equals(resource.getSpec().type())) // <--- only difference with original method
						.build());
	}
Linguagem predominante
Java
Estrelas
943
Forks
245
Merge médio
1d 11h
PRs com merge (30d)
28

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de operator-framework/java-operator-sdk

Todas as issues de operator-framework/java-operator-sdk

Issues semelhantes

Mais issues de Java

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.