コントロールパネルの全般ページでサーバ情報を編集・保存するとnullな項目が空文字に置き換わる

[samunohito]

💡 Summary

取得時は↑のような内容なのですが、shortName（画面上ではサーバ略称）だけを空欄にして保存ボタンを押すと

↑空文字が送信され、nullだった項目が空文字となってしまいました。

🥰 Expected Behavior

ClientServerService.tsなど、フィールドがnullであることを期待する処理はいくつかあるので、空文字の場合はnullとして登録するのが望ましい挙動と考えます。

🤬 Actual Behavior

nullだったフィールドがフロントエンドを経由することで空文字として登録される

📝 Steps to Reproduce

1. サーバ情報などがnullなサーバを用意する
2. コントロールパネルの全般ページでサーバ情報を更新する

💻 Frontend Environment

* Model and OS of the device(s): any
* Browser: any
* Server URL: any
* Misskey: 2024.11.0

🛰 Backend Environment (for server admin)

* Installation Method or Hosting Service: any
* Misskey: 2024.11.0
* Node: any
* PostgreSQL: any
* Redis: any
* OS and Architecture: any

Do you want to address this bug yourself?

• [ ] Yes, I will patch the bug myself and send a pull request

[samunohito]

サーバ側の実装を見るとnullも受け付けることから、

• nullである場合はnullをそのまま送り返す
• 空文字である場合はnullとする
• （可能であれば）変更のないフィールドはリクエストに含めない

のような仕組みをフロントエンド側に設けるのが良いと考えます

[syuilo]

バックエンド側でnullと空文字が区別される状態になっているのが諸悪の根源だわね

[samunohito]

（変えてないはずの値を別の値にして送り返してる…という所に対して違和感を感じるのだけど、僕だけかしら…）

[syuilo]

別の値にしてしまうのはバックエンドがおかしな値を送ってきてるせいだからフロントエンドの実装にそこまで違和感はないわね

[samunohito]

本来、meta.nameなどで「空の値」として想定されるのは空文字であるということです…？ （だとすると、テーブル定義はなぜnullableに…？という話に）

[syuilo]

本来空の場合は空文字にしたい nullableは歴史的経緯だわね

[syuilo]

まあ空文字で持つとしてもAPIのレスポンス的にはnullにしたい可能性があるからその場合はフロントエンドで何かしらのケアは要るわね

[syuilo]

今からカラム定義を変えるのは現実的ではないからバックエンド的には空文字を許さない方向にして、フロントエンドから空文字が飛んできたらnullとみなすようにするのが良さそう

[syuilo]

本来空の場合は空文字にしたい nullableは歴史的経緯だわね

理由: 型が簡潔になり、空判定も簡潔になる

[samunohito]

フロントエンドから空文字が飛んできたらnullとみなすようにするのが良さそう

undefinedがきた -> その値は変えない null -> nullにする 空文字 -> nullにする

なら、まあ…いいのかな…？

[fruitriin]

明示的にnullになることに依存した実装がなければ、BEでnullを空文字にして保存、DBのnullを空文字変換、非nullableかにマイグレーションするほうが今度の展開的によい気がする

---

追記： カラム定義変更が難しい理由ってあるっけ（DBのマイグレーションに時間がかかるのはダウンタイムを予告しておけばいいのではないかなあ）