Migration with is not idempotent when combining default=null and Maybe type

オープン
#1,535 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
haskell, postgresql
領域
databases

調査の方向性

リンク先の行にある Database/Persist/Postgresql.hs 周辺のマイグレーション比較ロジックから始め、次に pull request 1534 の失敗している再現テストを確認してください。Maybe フィールド、nullable の状態、デフォルト値が newcols と既存のカラムでどのように表現されているかを追跡してください。このスキーマに対するマイグレーションを繰り返しても ALTER TABLE ... SET DEFAULT null が出力されなくなり、回帰テストが成功すれば完了です。

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

説明

On the project that I work on, we have a default field similar to this:

SomeEntity
  name    Text Maybe    default=null

When we run migrations on the project, we always get:

ALTER TABLE "some_entity" ALTER COLUMN "name" SET DEFAULT null;

The column default gets set as 'nullable' in the database but every time we run migrations this ALTER TABLE is still output.

As with #1532 I looked at this by adding some logging here:

https://github.com/yesodweb/persistent/blob/a4b489032b9bb14a3637522aae89014b714494a4/persistent-postgresql/Database/Persist/Postgresql.hs#L1568

And looked in newcols and fst old' (the new columns vs existing columns), showing the field name and default value on the Column.

Here are the values that were logged out:

-- this is from `newcols`
(FieldNameDB {unFieldNameDB = "text_field"},Just "null")

-- this is from `fst old`
(FieldNameDB {unFieldNameDB = "text_field"},Nothing)

Different to 1532 where there is obviously a mis-match with the cases of the strings, I am less clear what is going on here. I am familiar enough with the types in persistent to know that the concept of nullable is also tracked beyond this field cDefault field here (ie on column there is cNull, there are also similar fields on other types), and I think it might be that in the case where there is Nothing for the default value the null has actually been converted into a flag to signal it being nullable somewhere else (while that hasn't happened on the parsed migration).

I'm not sure at all what the solution would be to this, but I'd be happy to also look to fix this too if I could get some steer in the right direction.

A key point to this issue is I think it is down to the fact that the field is already using Maybe in conjunction to a default null value, in this case, we may not actually need to specify default=null in our entity definitions, and that might be the solution here. But it may also be good for persistent to warn about this if you write this in your entity definitions.

I created a test to recreate this, there is an open PR with failing test here:

https://github.com/yesodweb/persistent/pull/1534

主要言語
Haskell
スター
486
フォーク
307
PR マージ指標
30日以内にマージされた PR はありません

環境構築

はじめの一歩

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

yesodweb/persistent のほかの issue

yesodweb/persistent の issue をすべて見る

似ている issue

Haskell の issue をもっと見る

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

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