GORM v1 → v2に移行したときの変更点/Changes when moving from GORM v1 to v2

Slide 1

Slide 1 text

Slide 2

Slide 2 text

Copyright © Bitkey Inc. All rights reserved. 2 自己紹介上窪大暉 (うえくぼだいき) X: https://x.com/daikideal GitHub: https://github.com/daikideal Qiita: https://qiita.com/daikideal Zenn: https://zenn.dev/daikideal 略歴 ● 2020年8月　エンジニアキャリアスタート ● 2022年12月　ビットキーに入社 ● 2023年10月　Cross Service Backendチームに異動 ○ → 認証認可基盤を開発今やっていること ● バックエンドの開発 (Goを使用) ● CI/CDの改善 ● インフラの保守・運用登壇者について

Slide 3

Slide 3 text

Slide 4

Slide 4 text

Slide 5

Slide 5 text

Slide 6

Slide 6 text

Copyright © Bitkey Inc. All rights reserved. 6 ● 機能が豊富なことをウリにしている ○ レコード to 構造体へのマッピング ○ クエリビルダー ○ DBマイグレーション ○ …etc ● GoのORMとしては最もポピュラー ○ スター数(*) ○ Goのイベントで情報交換しての肌感 ● v1とv2がある *...スライド作成時点(2024年11月末)で37,100でGoのORMではトップ GORMについて GORMの特徴

Slide 7

Slide 7 text

Slide 8

Slide 8 text

Slide 9

Slide 9 text

Slide 10

Slide 10 text

Slide 11

Slide 11 text

Slide 12

Slide 12 text

Copyright © Bitkey Inc. All rights reserved. 12 ● v1のままになっていることによる実害はない → チームのタスクにはなっていない ● できればv2に移行しておいた方がいい ○ v1はもうメンテナンスされないので脆弱性対応が入らない ○ v1ではcontextの伝搬(*)に対応していないが、v2では対応 ○ サービスごとにバージョンが違うと管理しづらい *...`func (*DB) WithContext`というメソッドで有効にできる v2移行の背景 v2に完全移行したい

Slide 13

Slide 13 text

Copyright © Bitkey Inc. All rights reserved. 13 ● スカンクワーク(*)という制度があるので毎週少しずつ進められた ○ リリースまでは約2ヶ月ほど ● 進め方 ○ importの "github.com/jinzhu/gorm" を "gorm.io/gorm" に置換して go build し、落ちたところを直す ○ 単体テストを実行して落ちたところを直す ○ E2Eテストを実行して落ちたところを直す *...社員が本来やるべき業務以外の自主的活動のことで、Google社の20%ルールと似ている。　1週間スプリントである我々のチームでは毎週金曜日がスカンクに当たる v2移行の背景どう進めたか

Slide 14

Slide 14 text

Slide 15

Slide 15 text

Copyright © Bitkey Inc. All rights reserved. 15 変更点 1. コネクションの開け方 2. コネクションプールの設定方法 3. コネクションの閉じ方 4. エラーハンドリングの方法 5. Loggerの設定方法 6. Limit(), Offset() に渡す引数の型 7. byteaのゼロ値の取り扱い ※後半に行くにつれて対応難易度が上がります修正が必要だった箇所は主に7つ

Slide 16

Slide 16 text

Slide 17

Slide 17 text

Slide 18

Slide 18 text

Copyright © Bitkey Inc. All rights reserved. 18 ● GORMはdatabase/sqlの`sql.DB`を使ってコネクションプールを保持する ● `gorm.DB`から`sql.DB`を取得する`func (*DB) DB`の戻り値が変更 ○ v1: `*sql.DB`を返す ○ v2: `*sql.DB`とerrorを返す変更点コネクションプールの設定

Slide 19

Slide 19 text

Slide 20

Slide 20 text

Slide 21

Slide 21 text

Slide 22

Slide 22 text

Slide 23

Slide 23 text

Slide 24

Slide 24 text

Copyright © Bitkey Inc. All rights reserved. 24 ● Loggerを設定するタイミングが変更 ○ v1: `func Open`で受け取った`type DB`の`func (*DB) SetLoggerを呼び出す ○ v2: `func Open`の引数`type Config`に`logger.Interface`を満たす構造体を含める変更点 Loggerの設定

Slide 25

Slide 25 text

Slide 26

Slide 26 text

Slide 27

Slide 27 text

Copyright © Bitkey Inc. All rights reserved. 27 ● インターフェースが変更 ○ v1: 引数に`interface{}`を受け取る ○ v2: 引数に`int`を受け取る ● ページネーションを以下のようなドメインオブジェクトとして定義して usecase ↔ repositoryでやりとりしていたので影響あり変更点 Limit(), Offset() に渡す引数の型

Slide 28

Slide 28 text

Copyright © Bitkey Inc. All rights reserved. 28 変更点 Q. ドメインの定義を修正するか、repositoryの処理内でキャストするか A. repositoryの処理内でキャストする理由: ● `int`にしないといけないのはデータアクセス上の都合 ● GORMをバージョンアップした影響でドメインに変更を加えるのは好ましくない Limit(), Offset() に渡す引数の型

Slide 29

Slide 29 text

Slide 30

Slide 30 text

Copyright © Bitkey Inc. All rights reserved. 30 ● Goの`[]byte`はPostgreSQLのbytea型として保存できる ● NOT NULL制約つきのbytea型のカラムにnilを入れた時の挙動に差異あり ○ v1: `\x`(*)としてInsertされる ○ v2: NOT NULL制約違反エラーが発生する ● 原因がわからなかったのでテストコードで検証 ○ https://github.com/daikideal/gorm-demo もし原因をご存知の方がいらっしゃいましたら教えていただけると嬉しいです 🙇 *...空のbytea。Postgresはバイナリ列をSQLフォーマットで入出力するとき文字列に変換するが、このときデフォルトで使われるのがhex書式で、`\x`が文字列の先頭につく。参考: https://www.postgresql.jp/docs/9.4/datatype-binary.html 変更点 byteaのゼロ値