0xPlaygrounds / 0xPlaygrounds/subgrounds

Better `FieldPath` argument validation

オープン
#10 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
enhancement
主要言語
Python
スター
73
フォーク
12
PR マージ指標
30日以内にマージされた PR はありません

説明

**Is your feature request related to a problem? Please describe.** Yes. When constructing `FieldPaths` with arguments, any extra arguments (i.e.: arguments which don't exist in the subgraph schema) are silently ignored, leading to harder debugging in case of errors like typos.

Moreover, although the values of real arguments are type-checked, the exceptions are cryptic and uninformative.

**Describe the solution you'd like** When constructing `FieldPaths` with arguments, for each argument, Subgrounds should check whether:

1. The argument exists in the schema
2. The type of the argument's value matches the type indicated in the schema
3. If using relative `FieldPaths` (e.g.: `subgraph.Query.entities(orderBy=subgraph.Entity.field)`), validate that the field type on which that argument is applied matches the type of the relative `FieldPath` (i.e.: the type of `entities` matches the `Entity` object).

Error messages should also be clear and informative. E.g.: "X is not a valid value for argument orderBy".

**Describe alternatives you've considered** None

**Additional context** None

**Implementation checklist**

* [ ] Validate arguments
* [ ] Check whether the argument exists in the schema
* [ ] Check whether the value given to the argument matches the type specified in the schema
* [ ] Check whether relative `FieldPaths` match the type of the field
* [ ] Improved error messages

*Originally from: cvauclair*

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

Look at the FieldPath class and its argument handling. The subgraph schema is used for validation. Start by understanding how arguments are currently passed and ignored. Check the schema for argument definitions and types. Write validation logic that raises clear error messages for missing arguments or type mismatches. Test with a subgraph query to ensure errors are informative.

索引モデルが issue の本文から書いたものです。

評価

技術スタック
graphql, python
領域
backend-api-design, devtools
issue の種類
機能追加
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。