microsoftgraph / microsoftgraph/msgraph-sdk-java

Improve v6 for better Generics usage

Aberta
#2,320 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

status:waiting-for-triage type:feature
Linguagem predominante
Java
Estrelas
444
Forks
154
Merge médio
18h 28min
PRs com merge (30d)
4

Descrição

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

We are trying to use v6 with generic methods to reduce duplicate boiler plate code, but struggle to do this efficiently. We struggled with the following:

  1. GetRequestConfiguration
    This class seems to be part of each Builder class and there is not one abstract parent implementation for all Builder classes. We can't write a generic method handling each entity because there are hundreds of seperate GetRequestConfiguration implementations, e.g. one for UsersRequestBuilder and this method now can only be used for UsersRequestBuilder:
public static Consumer<UsersRequestBuilder.GetRequestConfiguration> addAdvancedQueryCapabilities() {
		return cust -> {
			Objects.requireNonNull(cust.queryParameters).count = true;
			cust.headers.add("ConsistencyLevel", "eventual");
		};
	}

The same applies for PostRequestConfiguration and all other classes.

  1. BaseCollectionPaginationCountResponse
    Here we see some problems:
  • This class is not typed at all. In v5 there is a generic return type of the response class which determines the correct class for the actual item values in the page collection.
  • After the typing you could add getValue to the base class and not implement it in each subclass which should help to determine the actual return type in v6 as well.
  • Also we think as improvement createFromDiscriminatorValue should be overwritten in each subclass with it's correct implementation (I think this is already done), but we don't understand why we have the need to manually pass the correct descriminator to the PageIterator. We believe this can be done automatically without manual interaction.

Our call currently looks like this using a similar PageIterator as seen in here:

UserCollectionResponse page = userCollectionRequest.get(customizer);
List<User> users = RequestUtils.collectListFromAllPages(this.graphClient.getGraphServiceClient(), page,
	UserCollectionResponse::createFromDiscriminatorValue, this.getClass());

We already pass a UserCollectionResponse but we don't understand why the PageIterator does not get it's discriminator automatically and we have to set it manually by passing the explicit discriminator.

Also we can't use var users = ..., because we need to declare the return type as Entity and can't get it from UserCollectionResponse since that class is not typed.

What do you think about this?

Describe the solution you'd like.

For 1)
Use interfaces for the Configurators, such that generic implementations can be done using these interfaces.

For 2:
Already proposed above

Additional context?

No response

Guia de contribuição

Abrir o guia de contribuição

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.

Direção de pesquisa

Comece lendo as implementações de GetRequestConfiguration nas classes Builder e, em seguida, inspecione BaseCollectionPaginationCountResponse, UserCollectionResponse e o uso de PageIterator. O resultado proposto pela issue é o suporte a configuradores genéricos, respostas de coleção tipadas e menos tratamento manual de discriminadores; nenhum arquivo ou teste específico foi nomeado.

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

Avaliação

Stack de tecnologia
java
Domínio
api
Tipo de issue
Funcionalidade
Dificuldade
5/5
Tempo estimado
Mais de uma semana
Status de atividade
Estagnada
Clareza
Precisa de esclarecimento
Facilidade para iniciantes
25/100

Receba novas issues na sua caixa de entrada

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