microsoftgraph / microsoftgraph/msgraph-sdk-java
Improve v6 for better Generics usage
まだ誰も着手していません。
- 主要言語
- Java
- スター
- 444
- フォーク
- 154
- 平均マージ
- 18時間 28分
- マージ済み PR(30日)
- 4
説明
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
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず Builder クラス全体の GetRequestConfiguration 実装を読み、次に BaseCollectionPaginationCountResponse、UserCollectionResponse、および PageIterator の使用箇所を調べてください。Issue で提案されている成果は、汎用コンフィギュレーターのサポート、型付きコレクションレスポンス、そして discriminator の手動処理の削減です。特定のファイルやテストは指定されていません。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- java
- 領域
- api
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100