[REQ][dart-dio] Support useOptional / patchOnly with serializationLibrary=freezed

オープン
  • 何か問題がありますか？
#25,310 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
42/100
issue の種類
機能追加
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
dart

調査の方向性

Read the prior change in #25250 and inspect the Dart Dio generator’s Freezed templates and tests for useOptional and patchOnly; the payload does not name specific files. Prototype the proposed Freezed-specific Optional<T> serialization and check generated code for absent, explicit null, and present values, including the stated defaults and unknown enum behavior. Done when those cases work for wrapped properties while unaffected Freezed output remains unchanged.

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

説明

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

Since #25250 added serializationLibrary=freezed (beta), useOptional and patchOnly are ignored under freezed and a warning is logged.

Freezed models declare every optional property as T? with includeIfNull: false. A PATCH body therefore cannot express the three states that partial updates need (JSON Merge Patch, RFC 7396):

Intent JSON
Leave unchanged key omitted
Clear the field "field": null
Set the field "field": "value"

With a plain T?, null can only mean one of the first two. Today it means "omit", so clients cannot clear a field. Switching to includeIfNull: true would instead send null for every unset field and wipe data on the server.

Describe the solution you'd like

Support useOptional / patchOnly with freezed, using the same Optional<T> API (Optional.absent() / Optional.present(value)) as the built_value and json_serializable backends:

UpdateItem(name: 'x')                                    // {"name":"x"}
UpdateItem(name: 'x', imageId: Optional.present(null))   // {"name":"x","imageId":null}
UpdateItem(name: 'x', imageId: Optional.present('i'))    // {"name":"x","imageId":"i"}
UpdateItem.fromJson({'name': 'x', 'imageId': null}).imageId  // Optional.present(null)
UpdateItem.fromJson({'name': 'x'}).imageId                   // Optional.absent()

Proposed design (prototyped with freezed 3.2.5 / json_serializable 6.14, Dart 3.13):

  • A freezed-specific optional.dart in which Optional<T> follows json_serializable's generic-helper protocol, Optional.fromJson(json, fromJsonT) / toJson(toJsonT). json_serializable then generates the inner conversion itself for enums, DateTime, nested models, lists and maps.
  • Optional.absent() serializes to a private sentinel. Affected models use @Freezed(toJson: false) with a factory-level @JsonSerializable(createToJson: true), and their own toJson() strips sentinel keys. Without toJson: false, freezed generates a toJson() that bypasses the stripping.
  • @JsonKey(readValue: readOptionalValue) distinguishes a missing key from an explicit null. json_serializable otherwise reads null as absent.
  • Only models with wrapped properties change. All other freezed output, including the existing samples, is unchanged.

Decisions worth reviewing:

  • Spec defaults. A wrapped property with a default starts as Optional.absent(), not Optional.present(default), because sending the default in a PATCH would overwrite server state. json_serializable currently uses present(default).
  • enumUnknownDefaultCase. It is not applied to wrapped enum fields, because json_serializable rejects unknownEnumValue on Optional<Enum?>. Unknown values throw.
  • Binary properties are never wrapped; they are excluded from JSON anyway.
  • patchOnly scope is unchanged: only schemas $ref'd directly by a PATCH request body are wrapped.
  • Out of scope: operation parameters (path, query, header, form) stay unwrapped, as with the other backends. Clearing a multipart/form-data field is not addressed, because form data has no null.
Describe alternatives you've considered
  • Reusing the shared optional.mustache / OptionalConverter<T>. json_serializable does not apply a generic converter to concrete types such as Optional<String?>. With serializationLibrary=json_serializable and useOptional=true, build_runner currently fails with Could not generate fromJson code for ... To support the type Optional ... (separate bug report to follow).
  • includeIfNull: false on wrapped fields. json_serializable cannot omit a key based on its value, so this also drops Optional.present(null).
  • Sending the full object (PUT-style) with includeIfNull: true. This works only when the client always has the complete current state, sends more data, and can overwrite concurrent edits.
Additional context

Follow-up to #25250. I would like to implement this and can open a PR if the approach looks good.

主要言語
Java
スター
26.9k
フォーク
7.8k
平均マージ
2日 10時間
マージ済み PR（30日）
180

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

OpenAPITools/openapi-generator のほかの issue

OpenAPITools/openapi-generator の issue をすべて見る

似ている issue

Java の issue をもっと見る

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

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