microsoftgraph / microsoftgraph/msgraph-sdk-java
Improve v6 for better Generics usage
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 444
- Forks
- 154
- Avg merge
- 18h 28m
- Merged PRs (30d)
- 4
Description
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:
- 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.
- 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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the GetRequestConfiguration implementations across the Builder classes, then inspect BaseCollectionPaginationCountResponse, UserCollectionResponse, and PageIterator usage. The issue's proposed outcome is generic configurator support, typed collection responses, and less manual discriminator handling; no specific files or tests are named.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100